cadl/packages/website
Timothee Guerin fe67c784a2
Clarify algolia search key is designed to be public (#3085)
2024-04-01 19:14:59 +00:00
..
.scripts Improved ref docs for model (#2951) 2024-02-29 07:21:13 -08:00
definitions Website public beta (#2418) 2024-01-19 09:42:25 -08:00
mermaid-pre-renderer Migrate website to use docusaurus (#1266) 2022-11-14 12:44:38 -08:00
src Fix another set of accessibility issues (#3031) 2024-03-19 18:57:02 +00:00
static Fix cookies still saved (#3030) 2024-03-19 19:58:27 +00:00
themes Accessibility contrast tweaks (#3026) 2024-03-18 16:23:00 +00:00
versioned_docs/version-latest project-root typo corrected in docs (#3083) 2024-04-01 08:10:37 -07:00
versioned_sidebars Website public beta (#2418) 2024-01-19 09:42:25 -08:00
.eslintignore Migrate website to use docusaurus (#1266) 2022-11-14 12:44:38 -08:00
.eslintrc.cjs Vitest improvements: vitest-ui, watch mode for deps, debug config (#2791) 2024-01-22 09:56:55 -08:00
.gitignore Migrate website to use docusaurus (#1266) 2022-11-14 12:44:38 -08:00
README.md 1/3 TypeSpec: Find/Replace Content 2023-02-16 13:07:22 -08:00
babel.config.js Migrate website to use docusaurus (#1266) 2022-11-14 12:44:38 -08:00
docusaurus.config.ts Clarify algolia search key is designed to be public (#3085) 2024-04-01 19:14:59 +00:00
package.json Update dependencies to resolve vulnerabilities and license issue (#3081) 2024-03-29 21:22:06 +00:00
playground-versions.json Bump versions for release march 2024 (#2988) 2024-03-05 15:31:47 -08:00
sidebars.ts Fix codefixes docs (#3045) 2024-03-28 19:41:27 +00:00
tsconfig.config.json Vitest improvements: vitest-ui, watch mode for deps, debug config (#2791) 2024-01-22 09:56:55 -08:00
tsconfig.json Website public beta (#2418) 2024-01-19 09:42:25 -08:00
versions.json Versioned docs (Latest and Next) (#1469) 2023-01-03 19:02:22 +00:00

README.md

TypeSpec Website

This repo contains the code for static web generator for TypeSpec project using docusaurus.io

Support libraries that enable the demo features are in the packages/ directory. The demo code itself is in the website/ directory.

Instructions for editing or contributing to this website

Running the website

To get started with the website, run the following npm commands

To build for production:

> npm run build

To run the site on the local server

> npm start

(Be careful, after starting the server, do not close it while building on the existing code. The server will help you while debugging as it shows any changes that is causing trouble in the code.)

Adding an item on the navigation bar.

Items on the navigation bar are stored and maintained from the navbar.json file. To add or remove an item from the navigation bar, change the json from navbar.json. Check out where to find navbar.json file.

./sidebars.js