mirror of
https://github.com/ZJDoc/GitGuide.git
synced 2026-07-21 03:16:16 +08:00
docs(readme): add
This commit is contained in:
@@ -1,17 +1,15 @@
|
||||
# Welcome to MkDocs
|
||||
# GitGuide
|
||||
|
||||
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
|
||||
|
||||
## Commands
|
||||
|
||||
* `mkdocs new [dir-name]` - Create a new project.
|
||||
* `mkdocs serve` - Start the live-reloading docs server.
|
||||
* `mkdocs build` - Build the documentation site.
|
||||
* `mkdocs -h` - Print help message and exit.
|
||||
|
||||
## Project layout
|
||||
|
||||
mkdocs.yml # The configuration file.
|
||||
docs/
|
||||
index.md # The documentation homepage.
|
||||
... # Other markdown pages, images and other files.
|
||||
* 规范
|
||||
* README编写
|
||||
* 消息提交
|
||||
* 版本提交
|
||||
* 工具
|
||||
* Git
|
||||
* Commitizen
|
||||
* conventioanl-changelog
|
||||
* CommitLint+Husky
|
||||
* generator-standard-readme
|
||||
* 平台
|
||||
* GitLab
|
||||
* GitHub
|
||||
Reference in New Issue
Block a user