alvierahman90/gronk
1
0
Fork 0
mirror of https://github.com/alvierahman90/gronk.git synced 2024-10-22 12:21:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

add base_url documentation for blog mode

Browse Source
This commit is contained in:
Akbar Rahman 2024-04-13 20:16:23 +01:00
parent 390f5a789f
commit 8300c4ba45
Signed by: alvierahman90
GPG Key ID: 6217899F07CA2BDF
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
readme.md
View File

@ -88,6 +88,16 @@ This can be done by setting the `blog` variable to `true` in the `readme.md` [cu
Notes under this directory will be published to a blog, whose feed is accesible at `https://notes.alv.cx/notes/<directory..>/feed.xml`.
When blog mode is enabled, it is required that the `base_url` property is set in the top level `readme.md` file.
Note that there should be no trailing slash.
If a `readme.md` file does not exist, then an empty one can be created:
```md
---
base_url: https://notes.alv.cx
---
```
## Permalinks