rnx-kit/docsite
renovate[bot] 9982907d66
chore(deps): update dependency typescript to v5.1.6 (#2506)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-07-07 08:23:20 +00:00
..
blog chore(website): remove local blog in favour of the DevBlog (#2045) 2022-11-28 10:05:07 +00:00
docs docs: automate removal of badges from READMEs (#2324) 2023-04-14 08:24:28 +02:00
src docs: bump typescript to 5.0.2 (#2325) 2023-04-14 08:54:09 +02:00
static Align our CLI and configuration with @react-native-community/cli (#1618) 2022-06-20 10:30:28 -07:00
.gitignore docs: automate removal of badges from READMEs (#2324) 2023-04-14 08:24:28 +02:00
.yarnrc.yml chore(docsite): address Dependabot alerts (#2202) 2023-02-13 19:27:01 +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 docs: bump typescript to 5.0.2 (#2325) 2023-04-14 08:54:09 +02:00
generate.js docs: automate removal of badges from READMEs (#2324) 2023-04-14 08:24:28 +02:00
package.json docs: bump typescript to 5.0.2 (#2325) 2023-04-14 08:54:09 +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): update dependency typescript to v5.1.6 (#2506) 2023-07-07 08:23:20 +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.