https://github.com/mbinorg/mbin-docs
Mbin Docs using Docusaurus
https://github.com/mbinorg/mbin-docs
documentation documentation-generator mbin
Last synced: 4 months ago
JSON representation
Mbin Docs using Docusaurus
- Host: GitHub
- URL: https://github.com/mbinorg/mbin-docs
- Owner: MbinOrg
- Created: 2024-04-05T16:56:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-26T12:13:51.000Z (8 months ago)
- Last Synced: 2025-01-23T09:41:48.691Z (6 months ago)
- Topics: documentation, documentation-generator, mbin
- Language: JavaScript
- Homepage: https://docs.joinmbin.org/
- Size: 493 KB
- Stars: 1
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mbin-Docs
This repo is for building and running the documentation website, that is hosted on [docs.joinmbin.org](https://docs.joinmbin.org). The documentation this is building is coming from the mbin repos [docs folder](https://github.com/MbinOrg/mbin/tree/main/docs)
The docs are built using [Docusaurus](https://docusaurus.io/) and [Redocusaurus](https://github.com/rohit-gohri/redocusaurus).
### Installation
For running this site you need to have an [Mbin](https://github.com/mbinOrg/mbin) repository, where our docs are hosted. The update script takes care of copying over docs and images and generating an open-api json for generating the api docs.
By default the script assumes the mbin repo is in the same directory as this repo under the directory name `mbin`. If you want to use a different repo you can specify the path to the repo with the `-d` flag.
```bash
npm ci
./update_and_build.sh -d YOUR_MBIN_REPO
```
The repo that is linked will by default fetch and pull changes from the main branch. If you want to use another branch you can specify that by `-b BRANCH`.
It will only build the docs when there were changes in the branch, if you want to force it to rebuild the docs add a `-f`.
Use the `-s` flag to skip the production build and only update the docs (useful for local development).
### Local Development
```bash
npm 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
```bash
npm build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.