adyxax/www
1
0
Fork 0
Code Issues Activity

Markdown formatting tweaks to make cgit parser happy

Browse source
This commit is contained in:
Julien Dessaux 2022-11-09 00:09:34 +01:00
parent b7dd77ea06
commit b965306b26
Signed by: adyxax
GPG key ID: F92E51B86E07177E
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -19,6 +19,7 @@ Have a good time!
## Dependencies ## Dependencies
go is required for the search feature. Only go version >= 1.17 on linux amd64 (Gentoo) is being regularly tested. go is required for the search feature. Only go version >= 1.17 on linux amd64 (Gentoo) is being regularly tested.
hugo is required in order to build the website html pages. Only hugo >= 0.99.1 is being regularly tested. hugo is required in order to build the website html pages. Only hugo >= 0.99.1 is being regularly tested.
buildah is optionally required in order to build the container images with my deploy script. buildah is optionally required in order to build the container images with my deploy script.
@ -30,12 +31,13 @@ There is a makefile with everything you need, just type `make help` (or `gmake h
## Hugo ## Hugo
Contrary to popular usage, I do not use a theme with hugo. I decided to simplify write my own in order to keep it light and simple. Here is a breakdown of each folder's contents: Contrary to popular usage, I do not use a theme with hugo. I decided to simplify write my own in order to keep it light and simple. Here is a breakdown of each folder's contents:
- assets/: css files, which will be compiled into a single minified file. - assets/: css files, which will be compiled into a single minified file.
- content/: markdown files - content/: markdown files
- blog/: blog section of this website. - blog/: blog section of this website.
- books/: a log of simple reviews of books I read. - books/: a log of simple reviews of books I read.
- docs/: wiki like section, where information is not sorted just chronologically like in the blog section. - docs/: wiki like section, where information is not sorted just chronologically like in the blog section.
- search/: dummy section I need for the search feature. - search/: dummy section I need for the search feature.
- deploy/: container images building script. - deploy/: container images building script.
- layouts/: html, json and rss templates. Also some useful hugo shortcodes. - layouts/: html, json and rss templates. Also some useful hugo shortcodes.
- search: the go program that powers the search feature. - search: the go program that powers the search feature.