rnx-kit/docsite
dependabot[bot] 37405706e4
chore(deps): bump cross-spawn from 7.0.3 to 7.0.5 in /docsite (#3421)
2024-11-18 09:48:39 +00:00
..
docs docs: replace Algolia with offline search (#3358) 2024-09-17 08:18:05 +02:00
src chore: address Dependabot alerts (#3191) 2024-06-14 16:32:31 +02:00
static Clean and clarify the docs (#2713) 2023-09-29 12:55:14 +02:00
.gitignore docs: automate removal of badges from READMEs (#2324) 2023-04-14 08:24:28 +02:00
.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 docs: automate removal of badges from READMEs (#2324) 2023-04-14 08:24:28 +02:00
tsconfig.json Documentation Website (#1197) 2022-03-08 18:30:14 +01:00
yarn.lock chore(deps): bump cross-spawn from 7.0.3 to 7.0.5 in /docsite (#3421) 2024-11-18 09:48:39 +00: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.