Michael Bromley 6141a8e3f1 chore: Include React component/hooks docs hace 2 años
..
content 63e7e443bd Merge branch 'minor' into new-docs hace 2 años
docs 6141a8e3f1 chore: Include React component/hooks docs hace 2 años
layouts 63e7e443bd Merge branch 'minor' into new-docs hace 2 años
scraper 2645afb855 docs: Add complete plugin tutorial hace 2 años
src 10fab25388 docs: Add docs to ui extensions types & guides hace 2 años
static 6fd0c67129 docs: Styling hace 2 años
.gitignore 2645afb855 docs: Add complete plugin tutorial hace 2 años
README.md 517bd109cb chore: Get docs building in docusaurus hace 2 años
babel.config.js 517bd109cb chore: Get docs building in docusaurus hace 2 años
docusaurus.config.js 0f3a28e613 docs: Improve docs landing page hace 2 años
package.json 20978e9b5e docs: Get docs build working hace 2 años
sidebars.js 432092e75f docs: Add docs on UI library components hace 2 años
tsconfig.json 517bd109cb chore: Get docs building in docusaurus hace 2 años
yarn.lock 20978e9b5e docs: Get docs build working hace 2 años

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.