From 6ce250b863624c71d293ff349d6edd0b5f575459 Mon Sep 17 00:00:00 2001 From: tastytea Date: Mon, 17 May 2021 04:20:39 +0200 Subject: [PATCH] Rewrite README from AsciiDoc to Github-flavored Markdown. Required to be listed on themes.gohugo.io. --- README.adoc | 106 ---------------------------------------------------- README.md | 98 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 98 insertions(+), 106 deletions(-) delete mode 100644 README.adoc create mode 100644 README.md diff --git a/README.adoc b/README.adoc deleted file mode 100644 index f302824..0000000 --- a/README.adoc +++ /dev/null @@ -1,106 +0,0 @@ -= nocolor -:project: hugo-theme-nocolor -:uri-base: https://schlomp.space/tastytea/{project} -:uri-archive: {uri-base}/archive/main.tar.gz -:uri-hugo: https://gohugo.io/ -:uri-slick: https://github.com/spookey/slick -:uri-slick-example: {uri-slick}/blob/master/_sites/example/config.toml -:uri-opengraph: http://ogp.me/ -:uri-schema: https://schema.org/ -:uri-twittercards: https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/abouts-cards.html -:uri-hugo-doc-toc: https://gohugo.io/content-management/toc -:uri-pygments: https://pygments.org/ -:uri-mozilla-aria-nav: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Navigation_Role - -*nocolor* is a link:{uri-hugo}[Hugo] theme with no predefined colors and minimal -styling. It is based on link:{uri-slick}[Slick]. - -== Features - -* Supports taxonomies of tags, categories and series with their own pages. -* RSS Feed with complete entries. -* link:{uri-opengraph}[Open Graph], link:{uri-schema}[Schema.org] and - link:{uri-twittercards}[Twitter Cards] support. -* Fully customizable menu entries. -* No JavaScript, no bundled fonts, no external requests. -* Ability to inject own CSS file. - -== Installation - -[source,shell] --------------------------------------------------------------------------------- -git submodule add --branch main https://schlomp.space/tastytea/hugo-theme-nocolor.git themes/nocolor -echo 'theme = "nocolor"' >> config.toml --------------------------------------------------------------------------------- - -Update with `git submodule update --remote`. If you don't keep your blog in a -git repository, install it with `git clone -https://schlomp.space/tastytea/hugo-theme-nocolor.git themes/nocolor` or unpack -the link:{uri-archive}[archive] into `themes/nocolor`. - -== Configuration & Modification - -Please take a look at the link:{uri-slick-example}[configuration example for -Slick]. It is valid for nocolor too, with these exceptions: - -* `favicon` and `css` have to be in in the assets folder. - -You can add things to the end of the `` section by overwriting the partial -template `extra_head.html` or above the footer by overwriting -`extra_foot.html`. The common way to do it is to create -`layouts/partials/extra_head.html` or `layouts/partials/extra_foot.html`, -respectively. - -=== Custom ARIA labels - -Some elements can't be labeled by default because we don't know what's going to -be in it. Custom link:{uri-mozilla-aria-nav}[ARIA labels] are supported for the -top menu and the bottom menu. - -.`config.toml` -[source,toml] --------------------------------------------------------------------------------- -[params] - [params.aria] - menu_top = "Main" - menu_bottom = "Contact" --------------------------------------------------------------------------------- - -=== Syntax highlighting with Asciidoctor - -If you want source code highlighting with AsciiDoc, you'll need pygmentize from -the package link:{uri-pygments}[pygments]. Set this in your config file: - -.`config.toml` -[source,toml] --------------------------------------------------------------------------------- -pygmentsCodefences = true -pygmentsCodeFencesGuessSyntax = false -pygmentsUseClasses = true --------------------------------------------------------------------------------- - -Run `pygmentize -L styles` for a list of available styles and generate a CSS -file: - -[source,shell] --------------------------------------------------------------------------------- -pygmentize -f html -S