Browse Source

Structured docs

master
Jan-Lukas Else 2 months ago
parent
commit
364bb2f334
  1. 24
      README.md
  2. 8
      docs/_config.yml
  3. 13
      docs/admin-paths.md
  4. 17
      docs/index.md

24
README.md

@ -1,25 +1,3 @@
# GoBlog
Hello!
This repository contains the code for GoBlog, my own blogging system. I created it because I was tired of all the workarounds to customize Hugo and other blog systems to my needs.
The goals of GoBlog are:
- Minimalism
- Performance
- Flexibility
- IndieWeb
To configure GoBlog, take a look at the `example-config.yml` file and save your configuration to `config\config.yml`. How to install and run GoBlog is explained in the [docs](docs/install.md).
Administration paths:
- Login: `/login`
- Logout: `/logout`
- Editor: `/editor` (prefixed with the blog path)
- Notifications: `/notifications`
- Webmentions: `/webmention`
- Comments: `/comment`
[jlelse](https://jlelse.blog)
How to install and run (and other useful information about) GoBlog is explained in the [docs](https://docs.goblog.app/).

8
docs/_config.yml

@ -1 +1,7 @@
theme: jekyll-theme-cayman
theme: jekyll-theme-cayman
title: GoBlog
description: Simple blogging system written in Go
github:
is_project_page: false

13
docs/admin-paths.md

@ -0,0 +1,13 @@
# Administration paths
Most settings can be adjusted via the configuration. But to create new posts, log in or out, see notifications or check webmentions there are fixed (partly configurable) paths:
- Login: `/login`
- Logout: `/logout`
- Notifications: `/notifications`
- Webmentions: `/webmention`
- Comments: `/comment`
Some paths are blog-relative, so they must be appended to the blog path:
- Editor: `/editor`

17
docs/index.md

@ -0,0 +1,17 @@
# GoBlog
With GoBlog [I](https://jlelse.blog) created my own blogging system, because it was too much work for me to implement all my ideas with already existing system. GoBlog is a dynamic blogging system, but inspired by Hugo, it has goals like performance and flexibility. It also implements many IndieWeb functionalities like Webmentions or IndieAuth to use your own blog as an identity on the internet.
License: MIT License
Blog: https://goblog.app/
Documentation: https://docs.goblog.app
Main repository: https://git.jlel.se/jlelse/GoBlog
GitHub mirror: https://github.com/jlelse/GoBlog
Codeberg mirror: https://codeberg.org/jlelse/GoBlog
More information about GoBlog:
- [How to install and run GoBlog](./install.md)
- [How to build GoBlog](./build.md)
- [Administration paths](./admin-paths.md)
Loading…
Cancel
Save