nisusam / miru-docs

Repository for Miru documents

Home Page:https://docs.getmiru.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Miru logo

Miru Documentation

This repository contains the Miru documentation website code and Markdown source files for docs.miru.so

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.

About

Repository for Miru documents

https://docs.getmiru.com/


Languages

Language:JavaScript 52.1%Language:TypeScript 31.8%Language:CSS 16.1%