Peiiii / docusaurus-example

Overview

This is an example of the Docusaurus v2 tool.

Some useful URL links about this topic

Show case you websites using Docosaurus v2

What is algolia docsearch

Integrate docosaurus with algolia docSearch

Docusaurus Docs

mdx codepen

HTML to JSX

Other alternatives to docusaurus

Gitbook Docsify Gatsby DeveloperHub

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