rnx-kit/docsite
Tommy Nguyen 04b2f32d64
chore: address CodeQL issues (#3359)
- https://github.com/microsoft/rnx-kit/security/code-scanning/5
- https://github.com/microsoft/rnx-kit/security/code-scanning/7
2024-09-17 08:18:55 +02:00
..
docs docs: replace Algolia with offline search (#3358) 2024-09-17 08:18:05 +02:00
src
static
.gitignore
.yarnrc.yml docs: replace Algolia with offline search (#3358) 2024-09-17 08:18:05 +02:00
README.md docs: replace Algolia with offline search (#3358) 2024-09-17 08:18:05 +02:00
babel.config.js docs: replace Algolia with offline search (#3358) 2024-09-17 08:18:05 +02:00
docusaurus.config.js docs: replace Algolia with offline search (#3358) 2024-09-17 08:18:05 +02:00
generate.js chore: address CodeQL issues (#3359) 2024-09-17 08:18:55 +02:00
package.json docs: replace Algolia with offline search (#3358) 2024-09-17 08:18:05 +02:00
sidebars.js
tsconfig.json
yarn.lock docs: replace Algolia with offline search (#3358) 2024-09-17 08:18:05 +02:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.