Skip to content

Better punctuation #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
devsharmaarihant wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Better punctuation #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@

## How to edit Seeed Wiki

We have the English and Chinese Wiki. The procedure is same. This article shows how to edit wiki step by step.
We have the English and Chinese wiki. The procedure is same. This article shows how to edit wiki step by step.

## Wiki Structure
## Wiki Structures

Seeed wiki uses [MkDocs template](https://squidfunk.github.io/mkdocs-material/) desgined by Martin Donath. It includes wiki source files and compiled html files.

Expand All @@ -25,7 +25,7 @@ Here is the structure of the html files.
### Preparation

- Step 1. Install Python, Pip and Mkdocs by following [mkdocs.org](http://www.mkdocs.org/).
- Step 2. run below command to install mkdocs-material
- Step 2. Run the below command to install the mkdocs-material

```python
pip install mkdocs-material
Expand Down Expand Up @@ -202,30 +202,30 @@ wiki **English-->mkdocs**
## How to update the banner

- Step 1. Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- Step 2. git clone https://github.com/SeeedDocument/wiki_english.git
- Step 2. Git clone https://github.com/SeeedDocument/wiki_english.git
- Step 3. cd wiki_english/docs/images/
- Step 4. modify the top_banner.png or right_banner.png
- Step 5. modify the top_banner hyperlink by editing the wiki_english/docs/index.md @ line #1 XXXXXX.
- Step 4. Modify the top_banner.png or right_banner.png
- Step 5. Modify the top_banner hyperlink by editing the wiki_english/docs/index.md @ line #1 XXXXXX.

```
<a href="https://XXXXXX" target="_blank">
```

- Step 6. modify the right_banner hyperlink by editing the wiki_english\material\partials\toc.html @ line #32 XXXXXX.
- Step 6. Modify the right_banner hyperlink by editing the wiki_english\material\partials\toc.html @ line #32 XXXXXX.

```
<td align="left"><a href="XXXXXX" target="_blank">
```

- Step 7. run below command to push the changes to github
- Step 7. Run below command to push the changes to github

```
git add .
git commit -m "update banner"
git push origin master
```

- Step 8. run below command to build the site.
- Step 8. Run below command to build the site.

```
mkdocs build --clean
Expand Down