rnx-kit/docsite
Tommy Nguyen f82c3bf880
docs(align-deps): update documentation on website (#1940)
2022-10-20 10:54:00 +02:00
..
blog Tweak blog (#1464) 2022-05-04 12:56:14 -07:00
docs docs(align-deps): update documentation on website (#1940) 2022-10-20 10:54:00 +02:00
plugins Update docusaurus (#1797) 2022-08-16 08:53:40 -07:00
src Use Algolia DocSearch as the search provider for our website (#1523) 2022-05-18 07:58:27 -07:00
static Align our CLI and configuration with @react-native-community/cli (#1618) 2022-06-20 10:30:28 -07:00
.gitignore Documentation Website (#1197) 2022-03-08 18:30:14 +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 Use Algolia DocSearch as the search provider for our website (#1523) 2022-05-18 07:58:27 -07:00
package.json Update docusaurus (#1797) 2022-08-16 08:53:40 -07:00
sidebars.js docs(tools-workspaces): add to docsite (#1723) 2022-07-07 09:30:08 +02:00
tsconfig.json Documentation Website (#1197) 2022-03-08 18:30:14 +01:00
yarn.lock Update docusaurus (#1797) 2022-08-16 08:53:40 -07: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.