lthn/docs

Lethean developer documentation (Docusaurus)

Find a file

avtushko2004 c7c7705115 Merge branch 'main' of https://github.com/PRavaga/zano-docs		2023-09-06 22:59:27 +03:00
docs	Merge branch 'main' of https://github.com/PRavaga/zano-docs	2023-09-06 22:59:27 +03:00
src	css warning fix	2023-09-06 22:20:43 +04:00
static	Merge branch 'main' of https://github.com/PRavaga/zano-docs	2023-09-06 22:59:27 +03:00
.gitignore	template setup	2023-08-31 13:30:05 +02:00
babel.config.js	template setup	2023-08-31 13:30:05 +02:00
docusaurus.config.js	projects images	2023-09-06 21:06:15 +04:00
package-lock.json	template setup	2023-08-31 13:30:05 +02:00
package.json	template setup	2023-08-31 13:30:05 +02:00
README.md	template setup	2023-08-31 13:30:05 +02:00
sidebars.js	api page example	2023-08-31 21:02:35 +02:00

Website

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.