-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: CaiJingLong <[email protected]>
- Loading branch information
1 parent
924e2a7
commit 223c9e5
Showing
1 changed file
with
32 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,32 @@ | ||
# Try to build docs by github actions | ||
# About the README | ||
|
||
The docs is generated by [hugo][]. | ||
|
||
It should provide version-independent content, | ||
such as compatibility-related documents and documents loaded by the release version of each plugins. | ||
|
||
If you want to read the docs of plugins, please see the README of each plugins. | ||
|
||
## Write docs | ||
|
||
You need add markdown file into [src/{lang}](./src/) directory. | ||
|
||
Also, you can use [script](./scripts/new.py) to create a new markdown file. | ||
|
||
```bash | ||
python3 scripts/new.py | ||
``` | ||
|
||
Write content in created markdown file, then open pull request. | ||
|
||
## Run in local | ||
|
||
If you want to preview new docs | ||
|
||
You must install [hugo][] first. | ||
|
||
```bash | ||
scripts/server.sh | ||
``` | ||
|
||
[hugo]: https://gohugo.io/ |