https://github.com/terra-money/alliance-docs
https://github.com/terra-money/alliance-docs
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/terra-money/alliance-docs
- Owner: terra-money
- License: other
- Created: 2022-11-11T19:05:31.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-06T18:14:39.000Z (over 1 year ago)
- Last Synced: 2024-04-14T22:52:28.773Z (over 1 year ago)
- Language: SCSS
- Size: 28.8 MB
- Stars: 2
- Watchers: 12
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Alliance Docs
---
## Setup
### 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= 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.
## Syntax
### Admonitions
You can use admonitions by importing them and using the following syntax:
```
import Admonition from '@theme/Admonition';
Some **content** with _markdown_ `syntax`.
```
The `icon` and `title` values are optional.
Admonition types:
```
note
tip
info
caution
danger
```
### Details
For dropdown details, use the following syntax:
example
```
hidden content
```
````
Title
```
hidden content
```
````
### Comments
```
{/*
this is a comment in mdx
*/}
```