N-archive/hacks-guide-minimal-mistakes-theme
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Improve Staticman v3 documentation (#2043)

Browse source 
* Corrected Staticman v3 info

* Added a link to eduardoboucas/staticman#219

* Fix typo
This commit is contained in:
Vincent Tam 2019-01-28 02:08:03 +01:00 committed by Michael Rose
parent cc4471e4dd
commit 622005cb44
1 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/_docs/05-configuration.md
View file

@ -392,7 +392,19 @@ Transform user comments into `_data` files that live inside of your GitHub repos
###### Staticman v3 ###### Staticman v3
Due to the support for GitLab, the URL scheme has been changed. Bewteen `v3` and `/entry`, one needs to input a Git service provider (either `github` or `gitlab`). Apart from that, the setup for GitHub remains the same. Due to the [support for GitLab](https://github.com/eduardoboucas/staticman/pull/219), the URL scheme has been changed. Between `v3/entry/` and `/{your Git username}`, one needs to input a Git service provider (either `github` or `gitlab`). For example
https://{your Staticman v3 API}/v3/entry/github/{your Git username}/{your repository name}/...
```yaml
# _config.yml (defaults)
repository : # Git username/repo-name e.g. "mmistakes/minimal-mistakes"
comments:
provider : "staticman_v2"
staticman:
branch : "master"
endpoint : https://{your Staticman v3 API}/v3/entry/github/
```
###### Staticman v2 ###### Staticman v2