Docusaurus

Generate and deploy modern static websites efficiently, with features for live reloading during development and seamless deployment to GitHub Pages or other static hosting services. Provides an extensible framework for website management and content generation.

Author

Docusaurus logo

anewkim

MIT License

Quick Info

GitHub GitHub Stars 0
NPM Weekly Downloads 0
Tools 1
Last Updated 23/2/2023

Tags

anewkim docusaurus content anewkim docusaurus creation anewkim docusaurus generate

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.