cadl/packages/website
Christopher Radek 1455928d25
TypeSpec 0.59 - August 2024 Release branch (#4120)
Co-authored-by: Christopher Radek <Christopher.Radek@microsoft.com>
2024-08-08 04:54:25 +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 to eslint flat config (#3123) 2024-04-08 09:58:19 -07:00
src Update getting started http guide (#3684) 2024-07-15 15:42:17 +00:00
static Store what would have been cookies in memory instead so the field is still sent (#3956) 2024-07-24 16:31:20 +00:00
themes Fix up some syntax highlighting with prismjs and monarch (#3587) 2024-06-14 20:16:04 +00:00
versioned_docs/version-latest TypeSpec 0.59 - August 2024 Release branch (#4120) 2024-08-08 04:54:25 +00:00
versioned_sidebars TypeSpec 0.59 - August 2024 Release branch (#4120) 2024-08-08 04:54:25 +00: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 Website scripts do not load when loading a deep page (#3952) 2024-07-24 16:29:05 +00:00
package.json Update dependencies (#3948) 2024-07-23 21:02:34 +00:00
playground-versions.json TypeSpec 0.59 - August 2024 Release branch (#4120) 2024-08-08 04:54:25 +00:00
sidebars.ts Add documentation on examples (#4074) 2024-08-01 18:26:02 +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