forked from terra-money/docs
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
112 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,112 @@ | ||
# Terra Docs | ||
|
||
<div align="center"> | ||
<a href="https://docs.terra.money/"> | ||
<img src="./static/img/docs_logo.svg" width=500> | ||
</a> | ||
</div> | ||
|
||
--- | ||
|
||
## 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=<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. | ||
|
||
## Syntax | ||
|
||
### Admonitions | ||
|
||
You can use admonitions by importing them and using the following syntax: | ||
|
||
``` | ||
import Admonition from '@theme/Admonition'; | ||
<Admonition type="note" icon="📝" title="Your Title"> | ||
Some **content** with _markdown_ `syntax`. | ||
</Admonition> | ||
``` | ||
|
||
The `icon` and `title` values are optional. | ||
|
||
Admonition types: | ||
|
||
``` | ||
note | ||
tip | ||
info | ||
caution | ||
danger | ||
``` | ||
|
||
### Details | ||
|
||
For dropdown details, use the following syntax: | ||
|
||
<details> | ||
<summary> example </summary> | ||
<p> | ||
|
||
``` | ||
hidden content | ||
``` | ||
|
||
</p> | ||
</details> | ||
|
||
```` | ||
<details> | ||
<summary> Title </summary> | ||
<p> | ||
``` | ||
hidden content | ||
``` | ||
</p> | ||
</details> | ||
```` | ||
|
||
### Comments | ||
|
||
``` | ||
{/* | ||
this is a comment in mdx | ||
*/} | ||
``` |