Skip to content
This repository has been archived by the owner before Nov 9, 2022. It is now read-only.

blockvigil/maticvigil-docs

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

MaticVigil Docs

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

$ cp -r docs/assets build/docs/

Docusaurus v2 changed the way static assets are loaded. We want to keep things simple from a Markdown perspective and hence the post build step.

$ cp static/sitemap.xml build/

Docusaurus v2 sitemaps are broken on build (work fine on dev).

Deployment

$ GIT_USER=<Your GitHub username> USE_SSH=true 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.