Michael Bromley eae35789b4 docs: Rearrange guides 2 سال پیش
..
docs eae35789b4 docs: Rearrange guides 2 سال پیش
scraper 2645afb855 docs: Add complete plugin tutorial 2 سال پیش
src 61952aed13 docs: Search bar styling 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 f17e0b306f docs: Fix more broken links 2 سال پیش
package.json 20978e9b5e docs: Get docs build working 2 سال پیش
sidebars.js a92d95bb05 docs: Add docs on custom fields & strategies etc 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.