1
0
mirror of https://github.com/cotes2020/jekyll-theme-chirpy.git synced 2025-12-18 05:41:31 +00:00

Improve the docs

- Add missing url references in the tutorial
- Add gem version badge in README
This commit is contained in:
Cotes Chung
2021-01-30 01:24:30 +08:00
parent eacad65cbb
commit a8b8a379f6
3 changed files with 11 additions and 6 deletions

View File

@@ -69,7 +69,6 @@ $ bash tools/init.sh
What it does is:
1. Remove some files or directories from your repository:
- `.travis.yml`
- files under `_posts`
- folder `docs`
@@ -78,7 +77,6 @@ What it does is:
3. Automatically create a commit to save the changes.
## Usage
### Configuration
@@ -157,3 +155,7 @@ $ docker run -it --rm \
```
Unless you specified the output path, the generated site files will be placed in folder `_site` of the project's root directory. Now you should upload those files to your web server.
[starter]: https://github.com/cotes2020/chirpy-starter
[use-starter]: https://github.com/cotes2020/chirpy-starter/generate
[workflow]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/workflows/pages-deploy.yml.hook