Skip to content
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.

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

章節撰寫範例 #3

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

章節撰寫範例 #3

wants to merge 6 commits into from

Conversation

smlsunxie
Copy link
Collaborator

@smlsunxie smlsunxie commented Oct 3, 2018

章節資料夾命名

資料夾命名: 主題-level-

練習章節:主題-level--lab-short-name
內容章節:主題-level--article-short-name
練習章節 範例: RN-basic-01-lab-rest-api
內容章節 範例: RN-basic-01-article-rest

資料夾結構

RN-basic-01-network
├── 01-lab-rest-api-A
│   ├── assets 章節所需附檔資料夾
│   ├── readme.md 章節主要內容
│   └── note.md 章節進行注意事項說明
├── 02-lab-rest-api-B
│   ├── assets 章節所需附檔資料夾
│   ├── readme.md 章節主要內容
│   └── note.md 章節進行注意事項說明
├── assets 此章所需附檔資料夾
└── readme.md 此章說明

針對練習章節相關規範如下:

章節內容組成

# 章節名稱
難度: 基礎 or 進階
目標: 練習或章節目的
專案: 範例使用的 repo
練習: 練習步驟說明
## 練習前設置
## 參考資料
附上在章節或練習進行中所需用到的資料或是指令

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant