8afb047e01
* fix: SourceHut documentation - Add it to sidebar and provider index - Fix broken link This fixes an oversight in #2359, where I had not fully understood how the documentation works. Signed-off-by: Conrad Hoffmann <ch@bitfehler.net> * fix: doc build instructions in docs/README.md --------- Signed-off-by: Conrad Hoffmann <ch@bitfehler.net> |
||
|---|---|---|
| .. | ||
| docs | ||
| src/css | ||
| static | ||
| versioned_docs | ||
| versioned_sidebars | ||
| .gitignore | ||
| README.md | ||
| babel.config.js | ||
| docusaurus.config.js | ||
| package.json | ||
| sidebars.js | ||
| versions.json | ||
README.md
Website
This website is built using Docusaurus 2, a modern static website generator.
Installation
npm install
Local Development
npm start
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
Build
npm run build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
GIT_USER=<Your GitHub username> USE_SSH=true npm 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.