rnx-kit/docsite
github-actions[bot] 31dea743c4
Version Packages (#1204)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2022-03-09 17:00:27 +01:00
..
blog Documentation Website (#1197) 2022-03-08 18:30:14 +01:00
docs Documentation Website (#1197) 2022-03-08 18:30:14 +01:00
src Documentation Website (#1197) 2022-03-08 18:30:14 +01:00
static Documentation Website (#1197) 2022-03-08 18:30:14 +01:00
.gitignore Documentation Website (#1197) 2022-03-08 18:30:14 +01:00
CHANGELOG.md Version Packages (#1204) 2022-03-09 17:00:27 +01:00
README.md Documentation Website (#1197) 2022-03-08 18:30:14 +01:00
babel.config.js Documentation Website (#1197) 2022-03-08 18:30:14 +01:00
docusaurus.config.js Documentation Website (#1197) 2022-03-08 18:30:14 +01:00
package.json Version Packages (#1204) 2022-03-09 17:00:27 +01:00
sidebars.js Documentation Website (#1197) 2022-03-08 18:30:14 +01:00
tsconfig.json Documentation Website (#1197) 2022-03-08 18:30:14 +01: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.