Skip to content

Commit 6cdb519

Browse files
committed
add docs
add docs
1 parent a506397 commit 6cdb519

File tree

4 files changed

+48
-0
lines changed

4 files changed

+48
-0
lines changed

docs/.debug.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
remote_theme: false
2+
3+
theme: jekyll-rtd-theme

docs/Gemfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

docs/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

docs/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## Welcome to PyMIC Documentation
2+
3+
This page is under construction, we will update it later.
4+
5+
### Features
6+
7+
### Installation
8+
9+
### Quick Start
10+
11+
### Links
12+
13+
### Markdown
14+
15+
Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for
16+
17+
```markdown
18+
Syntax highlighted code block
19+
20+
# Header 1
21+
## Header 2
22+
### Header 3
23+
24+
- Bulleted
25+
- List
26+
27+
1. Numbered
28+
2. List
29+
30+
**Bold** and _Italic_ and `Code` text
31+
32+
[Link](url) and ![Image](src)
33+
```
34+
35+
For more details see [Basic writing and formatting syntax](https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).
36+
37+
### Jekyll Themes
38+
39+
Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/HiLab-git/PyMIC/settings/pages). The name of this theme is saved in the Jekyll `_config.yml` configuration file.
40+
41+
### Support or Contact
42+
43+
Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://support.github.com/contact) and we’ll help you sort it out.

0 commit comments

Comments
 (0)