An open API service indexing awesome lists of open source software.

https://github.com/mapikit/meta-system-docs

The documentation for Meta-System
https://github.com/mapikit/meta-system-docs

Last synced: 5 months ago
JSON representation

The documentation for Meta-System

Awesome Lists containing this project

README

          

# Meta-System Docs

This is the homepage for the Meta-System's documentation.It was built using [Docusaurus](https://docusaurus.io/).

## Installation

you can use either NPM or Yarn for this, but Yarn in preferred.

```console
yarn install
```

## Local Development

```console
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

```console
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment

```console
GIT_USER= 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.