From aad837fddb4a798f2fa12dbf8f8bcd362104899a Mon Sep 17 00:00:00 2001 From: Daniel Tomlinson Date: Tue, 5 May 2020 04:24:18 +0100 Subject: [PATCH] Updating documentation --- commento.md | 4 +++- hugo.md | 43 ++++++++++++++++++++++++++++++++++++++++++- tasks.todo | 11 +++++++++-- 3 files changed, 54 insertions(+), 4 deletions(-) diff --git a/commento.md b/commento.md index 2c529af..66c676a 100644 --- a/commento.md +++ b/commento.md @@ -11,9 +11,10 @@ version: "3" services: server: + restart: unless-stopped image: registry.gitlab.com/commento/commento ports: - - 80:8080 + - 6050:8080 environment: COMMENTO_ORIGIN: localhost COMMENTO_PORT: 8080 @@ -21,6 +22,7 @@ services: depends_on: - db db: + restart: unless-stopped image: postgres environment: POSTGRES_DB: commento diff --git a/hugo.md b/hugo.md index 39c2251..7bfc4f7 100644 --- a/hugo.md +++ b/hugo.md @@ -67,6 +67,35 @@ Use the command `hugo new folder/content.md`. You can manually create the file, Example `config.toml` for this theme: . +#### Rebuilding theme + +Any custom scss should go in `./blog/themes/hugo-theme-chunky-poster/src/scss/chunky-poster.scss`. + +Beware that any overrides must come **before** the scss import. It is better to place them in `_variables.scss` as in the source code this comes before the bootstrap + chunky-poster stylesheets. + +Any bootstrap variable overrides can go in `_variables.scss` in that folder. + +To rebuild the theme for production, you should first do `yarn install` then `yarn build`. Make sure you do not commit the `node_modules` folder to git. + +##### Overriding css + +In the `_variables.scss` you can add an overrides section: + +```scss +// Overrides + +$body-bg: #f9f9f9; + +.navbar { + border-bottom: 1px solid rgb(210, 210, 214); +} + +body { + font-family: -apple-system, system-ui, BlinkMacSystemFont, "Segoe UI", Roboto, + "Helvetica Neue", Arial, sans-serif !important; +} +``` + #### Configuration In the `config.toml` you should configure the theme. @@ -111,6 +140,19 @@ url = "http://localhost/js/commento.js" Comments will then be available on a post page. +### Adding images to content + +You can edit the `config.toml` under the `[params]` stanza to edit the homepage description text on the homepage. The title is under the root header. + +Images should go in `contents/images`. For each post you can specify an image that shares the same filename. E.g `post1.md` should have `post1.png` in `content/images`. + +The homepage image should go under the `params` stanza. + +### Editing default files + +- homepage +- _index for posts (explain how) + ## Features ### Taxonomies @@ -194,4 +236,3 @@ A really useful feature is the ability to quickly generate a link to another pag [Who]({{< relref "about.md#who" >}}) ``` - diff --git a/tasks.todo b/tasks.todo index d5beee7..511d9e8 100644 --- a/tasks.todo +++ b/tasks.todo @@ -2,7 +2,7 @@ Projects: Tasks: Images: - ☐ Add image to homepage + document + ✔ Add image to homepage + document @done (5/5/2020, 4:09:20 AM) ☐ Add image to post + document Animate: @@ -11,9 +11,16 @@ Tasks: Do we add this to the html, or do we use the themes js options? Layout: - ☐ Sort out colour scheme + ✔ Sort out colour scheme @done (5/5/2020, 4:09:10 AM) + ☐ Document editing layout + Note: + How to edit the homepage, how to edit taxonomy content (the _index.html) file and what this means. + ☐ Change homepage description layout. 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/) + + Custom layout: + ☐ Use the envanto website layouts (whole static themes) to find suitable wallpaper for a post page.