Welcome to ezbot's public documentation repository. This website is built using Docusaurus, a modern static website generator.
$ npm
$ npm 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.
- Create or modify file(s) in the
docsfolder. - Commit files
- Open a pull request
When the pull request is merged, your changes will automatically go live. They will only be visible when viewing the 'next' version of the docs.
- Create or modify file(s) in the
versioned_docs/version-{{version_number}}folder. - Commit files
- Open a pull request
When the pull request is merged, your changes will automatically go live. They will be visible when viewing the version of the docs that you modified.
Docusaurus can manage multiple versions of your docs.
Example: Release a version 1.0 of your project:
npm run docusaurus docs:version 1.0The docs folder is copied into versioned_docs/version-1.0 and versions.json is created.
Your docs now have 2 versions:
1.0athttp://localhost:3000/docs/for the version 1.0 docscurrentathttp://localhost:3000/docs/next/for the upcoming, unreleased docs
It is possible to edit versioned docs in their respective folder:
versioned_docs/version-1.0/hello.mdupdateshttp://localhost:3000/docs/hellodocs/hello.mdupdateshttp://localhost:3000/docs/next/hello
$ npm build
This command generates static content into the build directory and can be served using any static contents hosting service.
Note: Search is only available in production and via:
$ npm run build
$ npm run serve