Skip to content

Akare123/shardeum-docs

 
 

Repository files navigation

Shardeum Documentation Site

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

Installation

npm install

Local Development

npm run 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

npm run 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 npm run deploy

Not using SSH:

GIT_USER=<Your GitHub username> npm run 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.

Search Bar

Add Algolia Search Bar with API Key:

https://docusaurus.io/docs/search#connecting-algolia

Search bar support without Algolia API Key (loads after deployed to production):

https://github.com/praveenn77/docusaurus-lunr-search

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 73.4%
  • SCSS 24.0%
  • CSS 2.6%