lthn/docs
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Lethean developer documentation (Docusaurus)
31 commits 1 branch 0 tags 23 MiB
Find a file
PRavaga d5f90e274d
use setion 
Signed-off-by: PRavaga <trueravaga@gmail.com>
2023-09-08 14:30:43 +04:00
docs use setion 2023-09-08 14:30:43 +04:00
src use setion 2023-09-08 14:30:43 +04:00
static use setion 2023-09-08 14:30:43 +04: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 use setion 2023-09-08 14:30:43 +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

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.