/docs-template

Lido Docs template

Primary LanguageJavaScript

Template

This is template for all Lido Docs sites built from Docusaurus static site generator

What you should do

Just create your awesome repo from this template by clicking Use this template button and rename template-related properties in docusaurus.config.js.
All properties that you need to change marked as TODO and checked in workflow to protect you from unexpected titles, paths or something else
Don't forget to update this readme of course

That's all! Enjoy building your pretty docs site.

Deployment

This template contains workflows for check on each pull request and deploy when the main branch has changed. Just create pull request to the main branch, wait for checks passed, so it will be ready to merge.

Docs below are form docusaurus documentation except for the deployment block

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.