Updating documentation

This commit is contained in:
2020-05-04 05:18:31 +01:00
parent 6d480412ea
commit f560f3cf7f
3 changed files with 59 additions and 0 deletions

34
commento.md Normal file
View File

@@ -0,0 +1,34 @@
# Commento
<https://docs.commento.io>
## Using docker
You can use docker-compose to quickly start up commento with a postgres instance.
```yaml
version: "3"
services:
server:
image: registry.gitlab.com/commento/commento
ports:
- 80:8080
environment:
COMMENTO_ORIGIN: localhost
COMMENTO_PORT: 8080
COMMENTO_POSTGRES: postgres://postgres:postgres@db:5432/commento?sslmode=disable
depends_on:
- db
db:
image: postgres
environment:
POSTGRES_DB: commento
POSTGRES_USER: postgres
POSTGRES_PASSWORD: postgres
volumes:
- postgres_data_volume:/var/lib/postgresql/data
volumes:
postgres_data_volume:
```

24
hugo.md
View File

@@ -93,6 +93,24 @@ Refer to the author in posts with the value in `name`.
`hugo new post/post-title.md`
#### Footer at bottom of page
On pages where the content does fill the full height, the footer won't go to the bottom of the page. To fix this (for taxomonies) you should add `min-height: calc(100vh - 121px);` to the `<main>` element in all the `list.html` files.
The hight to subtract should be the exact height of the footer.
#### Commento
You can add the url to the commento `.js` file in the `config.toml`.
```toml
[params.commento]
enable = true
url = "http://localhost/js/commento.js"
```
Comments will then be available on a post page.
## Features
### Taxonomies
@@ -117,6 +135,10 @@ Actor <- Taxonomy
For example, you could have a series taxomony to group together a long series of blog posts. This blog post could be "deploying Strapi to EB" and be comprised of many posts in different tags all grouped under one taxomony. You can then add additional series for different things and see them all from one place.
When you visit a taxomony URL (say <http://localhost:1313/tags/>) it will use (in theme) `./layouts/_default/list.html`.
If you want a custom layout for a certain taxomony, e.g author, create this file in the relative path: `./layouts/authors/list.html`.
#### Configure
You should define the taxonomies in the `config.toml`:
@@ -171,3 +193,5 @@ A really useful feature is the ability to quickly generate a link to another pag
[Neat]({{< ref "blog/neat.md" >}})
[Who]({{< relref "about.md#who" >}})
```

View File

@@ -16,3 +16,4 @@ Tasks:
Misc:
☐ Add search to project
✔ Add commento to project @done (5/4/2020, 4:59:34 AM)
☐ Add SEO (https://keithpblog.org/post/hugo-website-seo/)