foodogsquared/nixos-config
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/nixos-config.git synced 2025-01-31 04:58:01 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs/site: update README

Browse Source
This commit is contained in:
Gabriel Arazas 2024-06-10 18:41:47 +08:00
parent cecb71e113
commit 9cd69450d9
No known key found for this signature in database
GPG Key ID: 62104B43D00AA360
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/README.adoc
View File

@ -3,4 +3,15 @@
It's the documentation for my project rendered with Hugo and written with Asciidoctor format. It's the documentation for my project rendered with Hugo and written with Asciidoctor format.
There are some things you need to be There are some things you need to be aware of.
* This is basically an extended theme using https://github.com/foo-dogsquared/website[my website].
It is built on top of it so every single change will have to be adapted to it including the assets (especially).
* This heavily uses my https://github.com/foo-dogsquared/asciidoctor-foodogsquared-extensions[own set of Asciidoctor extensions].
* This uses my custom Asciidoctor templates.
Unfortunately, this is not doable with Hugo so it is done primarily with a hack that shadows the original `asciidoctor` executable with a custom script of the same name.
* This also uses nixpkgs with their Ruby packaging infrastructure.
You can see more details about developing and maintaining them in https://nixos.org/manual/nixpkgs/stable/#sec-language-ruby[the respective manual].