https://github.com/ernestbuffington/docs.metamz.network
METAMZ Network Docs
https://github.com/ernestbuffington/docs.metamz.network
Last synced: 20 days ago
JSON representation
METAMZ Network Docs
- Host: GitHub
- URL: https://github.com/ernestbuffington/docs.metamz.network
- Owner: ernestbuffington
- Created: 2023-05-09T14:44:05.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-10T05:08:51.000Z (almost 2 years ago)
- Last Synced: 2025-02-16T09:16:57.228Z (3 months ago)
- Language: JavaScript
- Size: 27.3 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Meta MZ Documentation
>⚠️ Under construction.
This documentation is built using [Docusaurus 2](https://v2.docusaurus.io/).
Check [docs.metamz.network](http://docs.metamz.network) for a live version!
### Installation
```
$ npm install
```
or
```
$ yarn
```
### Local Development
```
$ npm run start
```
or
```
$ 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
```
$ npm run build
```
or
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
```
$ 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.
### Guidelines
- Wrap file names and paths into inline code: `index.php`
- Use `>⚠️ Under construction` for missing parts
- Use [Admonitions](docs/doc1.md#Admonitions) as warning,info etc block
- Add code types to code blocks
- Add the filename as comment to the code block (if possible):
```php
// protected/config/web.php
return [
//..
'someValue' => [
'newValue'
]
//..
]
```
- Check the [Style Guide](docs/doc1.md)
### Main Navigation
The main navigation is managed in [docusaurus.config.js](docusaurus.config.js) within the `links` configuration.
### Documentation Sidebars
The sidebars of the different guides are managed in [sidebars.js](sidebars.js).
See [Docusaurus2 Sidebars](https://v2.docusaurus.io/docs/sidebar/) for more information.