Skip to content

Commit c89d810

Browse files
VincentTammmistakes
authored andcommitted
Improve Staticman v3 documentation (mmistakes#2043)
* Corrected Staticman v3 info * Added a link to eduardoboucas/staticman#219 * Fix typo
1 parent 11f77d8 commit c89d810

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

docs/_docs/05-configuration.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,19 @@ Transform user comments into `_data` files that live inside of your GitHub repos
392392

393393
###### Staticman v3
394394

395-
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.
395+
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
396+
397+
https://{your Staticman v3 API}/v3/entry/github/{your Git username}/{your repository name}/...
398+
399+
```yaml
400+
# _config.yml (defaults)
401+
repository : # Git username/repo-name e.g. "mmistakes/minimal-mistakes"
402+
comments:
403+
provider : "staticman_v2"
404+
staticman:
405+
branch : "master"
406+
endpoint : https://{your Staticman v3 API}/v3/entry/github/
407+
```
396408

397409
###### Staticman v2
398410

0 commit comments

Comments
 (0)