Skip to content

Commit

Permalink
sync up ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
forchain committed Dec 21, 2021
1 parent 22bdc23 commit c8e59ad
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Qitmeer Docs


Qitmeer is an Open-Source community and welcome everyone to give contribution with their own talent. In addition to coding, documentation is also an important work to share knowledge with the community. Here are the steps how we share our expererience of Qitmeer.

## Install Hugo
Expand All @@ -26,11 +25,13 @@ https://gohugo.io/getting-started/installing

## Depoit Qitmeer Docs locally

Download source code and launch web server:
First, you need to fork Qitmeer Docs repo ("**https://github.com/qitmeer/docs"**) to your own github namespace, which is "**https://github.com/forchain/docs**" in this case.

Then, download source code and launch web server:

```sh
$ git clone https://github.com/Qitmeer/docs ~/github.com/Qitmeer/docs
$ cd ~/github.com/qitmeer/docs/Document
$ git clone https://github.com/forchain/docs ~/github.com/forchain/docs
$ cd ~/github.com/forchain/docs/Document
$ hugo serve
...
Web Server is available at http://localhost:1313/docs/ (bind address 127.0.0.1)
Expand All @@ -54,7 +55,7 @@ You may complete those steps by one Hugo command:
$ hugo new content/tutorials/contribute-docs/_index.en.md
```

#### Note:
#### Note

1. the name of the subfolder must be in **hyphen-case** style, in this case, **"contribute-docs"**
1. the **en** part indicates the language, you may subsititue with other languages, for instance, **cn** stands for Chinese. Or you may drop this part to disable the multiple language support, then it would be like "**_index.md**"
Expand All @@ -68,7 +69,14 @@ $ hugo new content/tutorials/contribute-docs/_index.en.md

There is an index page include all the links under each category, it is located at the parent folder of the containing folder of document, which is **content/tutorials/_index.en.md** for this tutorial.

```markdown
- [Contribute Docs](./contribute-docs)
```

#### Note

1. it is a *relative* link to the *containing* folder
2. The link cannot contain whitespaces, that's why the naming style of the containing folder must be **hyper-case**.

## Edit document

Expand Down Expand Up @@ -113,7 +121,7 @@ Qitmeer is an Open-Source community and welcome everyone to give contribution wi
...
```

**Note:**
#### **Note**

Hugo will insert the title configured in Front Matter, so we should **NOT** add title in the content.

Expand Down

0 comments on commit c8e59ad

Please sign in to comment.