diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a974fe3 --- /dev/null +++ b/.gitignore @@ -0,0 +1,17 @@ + +# Created by https://www.gitignore.io/api/hugo +# Edit at https://www.gitignore.io/?templates=hugo + +/content/ + +### Hugo ### +# Generated files by hugo +/public/ +/resources/_gen/ + +# Executable may be added to repository +hugo.exe +hugo.darwin +hugo.linux + +# End of https://www.gitignore.io/api/hugo diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc new file mode 100644 index 0000000..cbfed8f --- /dev/null +++ b/CHANGELOG.adoc @@ -0,0 +1,13 @@ += Changelog +All notable changes to this project will be documented in this file. + +The format is based on https://keepachangelog.com/en/1.0.0/[Keep a Changelog], +and this project adheres to https://semver.org/spec/v2.0.0.html[Semantic Versioning]. + +== [1.0.0] - 2019-09-21 + +=== Added +* Create the base layout. +* Add the Asciidoctor content template. +* Create the template for RSS, Atom, and JSON web syndication feeds. +* Implement multilingual mode support. diff --git a/README.md b/README.md new file mode 100644 index 0000000..797e776 --- /dev/null +++ b/README.md @@ -0,0 +1,89 @@ +# Contentful + +It's a Hugo theme that focuses on being contentful by having the most +minimal format as much as possible while being readable. +That said, it is easy to extend and modify to implement the feature that +you want. + +It could also serve as a pretty introduction to Hugo themes since there +not much going on. + +Getting started with this theme is pretty easy. +All it needs is the `title` field from your site config. + +The base theme could also render menu entries (but nested menus are not supported). + +## Inlining CSS + +You can make the CSS to be inline instead by moving the CSS stylesheet in the assets +folder and edit the appropriate file. + +As of 2019-09-11, this stylesheet is located in `static/css/main.css` so it should be +easy to override it with your own modifications. + +## RSS, Atom, and JSON feeds + +You can have web syndication formats like RSS and Atom by setting [custom output formats](https://gohugo.io/templates/output-formats) to your site configurations. + +The theme supports output feeds for the homepage and site sections. + +Here is an example configuration on enabling all of them. + +```toml +# Visit the following for more information: +# https://gohugo.io/templates/output-formats + +# Defining the media type of the output formats +# For JSON format, it doesn't need to be since it's already built-in into Hugo +[mediaTypes] + [mediaTypes."application/atom+xml"] + suffixes = ["atom", "atom.xml"] # You can remove the "atom.xml" if you want + + # Redefining RSS media type for the additional suffix + [mediaTypes."application/rss+xml"] + suffixes = ["rss", "rss.xml"] # You can remove the "rss.xml" if you want + + +# Including all of the feed output formats in the build +[outputFormats] + [outputFormats.Rss] + mediaType = "application/rss+xml" + baseName = "index" + + [outputFormats.Atom] + mediaType = "application/atom+xml" + baseName = "index" + +# Indicating what output formats shall be included +# for the following kinds +[outputs] + # .Site.BaseURL/index.* is available + home = ["HTML", "JSON", "RSS", "ATOM"] + + # .Site.BaseURL/$section/index.* is available + section = ["HTML", "JSON", "RSS", "ATOM"] +``` + +## Multilingual mode support + +Multiple languages for your site is supported. +You can simply organize your content as discussed on [this blog post](https://regisphilibert.com/blog/2018/08/hugo-multilingual-part-1-managing-content-translation/). + +The theme requires a language code based from [IANA Language Subtag Registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) as defined from the [W3 documentation](https://www.w3.org/International/questions/qa-choosing-language-tags). + +As of 2019-09-21, only English and Tagalog is supported. +Contributions through translations are appreciated. + +## Inspirations + +This theme is inspired by the following beautiful and minimal pieces of work: + +* [Jeff Kreeftmeijer's site](https://jeffkreeftmeijer.com/) +* [Hugo XMin](https://github.com/yihui/hugo-xmin) +* [ratfactor.com](https://ratfactor.com/) +* [Arch Terminal](https://github.com/foo-dogsquared/hugo-theme-arch-terminal) (OK, I think this is just selling out; this is my first theme, btw) + +## License + +This theme is licensed under MIT license. +Please see the original license file for more details.