lthn/docs

Lethean developer documentation (Docusaurus)

Find a file

dhub-sync[bot] eacc845d9c Changes from dhub		2024-06-23 17:29:32 +00:00
docs	Changes from dhub	2024-06-23 17:29:32 +00:00
src	hidden projects	2023-09-11 15:37:03 +02:00
static	Changes from dhub	2024-06-23 17:29:32 +00:00
.gitignore	Autodoc manual	2024-05-10 17:49:16 +03:00
babel.config.js	template setup	2023-08-31 13:30:05 +02:00
docusaurus.config.js	Added algolia search	2023-11-20 13:26:21 +01:00
package-lock.json	updated config to support math	2023-09-09 01:00:29 +04:00
package.json	updated config to support math	2023-09-09 01:00:29 +04:00
README.md	Update README.md	2023-10-02 17:25:40 +02:00
sidebars.js	api page example	2023-08-31 21:02:35 +02:00

Zano Documentation

This website is built using Docusaurus 2, a modern static website generator.

$ yarn

$ 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.

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

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.