Michael Bromley 0f3a28e613 docs: Improve docs landing page 2 년 전
..
docs d57e9c74d8 docs: Update deployment docs 2 년 전
scraper 2645afb855 docs: Add complete plugin tutorial 2 년 전
src 0f3a28e613 docs: Improve docs landing page 2 년 전
static 6fd0c67129 docs: Styling 2 년 전
.gitignore 2645afb855 docs: Add complete plugin tutorial 2 년 전
README.md 517bd109cb chore: Get docs building in docusaurus 2 년 전
babel.config.js 517bd109cb chore: Get docs building in docusaurus 2 년 전
docusaurus.config.js 0f3a28e613 docs: Improve docs landing page 2 년 전
package.json 20978e9b5e docs: Get docs build working 2 년 전
sidebars.js d745347175 docs: Fix docgen issue 2 년 전
tsconfig.json 517bd109cb chore: Get docs building in docusaurus 2 년 전
yarn.lock 20978e9b5e docs: Get docs build working 2 년 전

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.