diff options
| author | dataCobra <datacobra@mailbox.org> | 2020-04-19 21:43:32 +0300 |
|---|---|---|
| committer | dataCobra <datacobra@mailbox.org> | 2020-04-19 21:43:32 +0300 |
| commit | d7d8239ef2daba2b9e4f725ec2f6399600131220 (patch) | |
| tree | 4ee1fa434832ecdedc92f874ded6738d1bf0e458 /README.md | |
| parent | 37a50f8a9244a1a9abd6c1e4380236fc613bd68a (diff) | |
Initial release of redesign
The theme is now completely rewritten from scratch. In the future it
will now be easier to make improvments to the theme.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 156 |
1 files changed, 147 insertions, 9 deletions
@@ -1,27 +1,165 @@ # Vitae -... is a blog theme for Hugo that **focuses on your content** with some cool new **features**. +... is a blog theme for Hugo that **focuses on your content**. -## Welcome the the REDESIGN. +## Redesign -The foundation of the theme is now completely rewritten from scratch. This -version is now ready for first tests and error analysis. - -Until the redesign can replace the current version, it will take some time. +The theme is now completely rewritten from scratch. In the future it will now +be easier to make improvments to the theme. If you notice anything, please write an issue. -**!This version should currently not been used for live-blogs!** +## Demo + +You can have a look on https://themes.gohugo.io. +[Link to demo](https://themes.gohugo.io/theme/hugo-vitae/) + + + +## List of Features + +Here is a short list with some of the features that are available for +Hugo-Vitae. + +For more explanation about various features, scroll down to **Features** + +* Easy to use, even with GDPR in mind +* Improved <head> part for SEO +* Optimized responsiveness for all kinds of devices +* Multilingual support for month names and other fixed strings +* Various front matter and configuration options for more flexible use. +* RSS feed +* Disqus comments (optional) +* Google Analytics integration (optional) +* Twitter cards and Open Graph tags integration +* And some other cool features... + +## Installation + +### Stable + +Download the [latest stable release](https://github.com/dataCobra/hugo-vitae/releases/latest). +It's available as `.zip` or `.tar.gz`. Decompress it into your `themes/` folder. + +### Development + +Change your current work directory into the root directory of your Hugo site +and clone the repository: ```sh cd themes git clone https://github.com/datacobra/hugo-vitae.git hugo-vitae -git checkout -b redesign ``` +For more information about installation read the +[official setup guide](https://gohugo.io/overview/installing/) of Hugo. + +## Features + +### GDPR in mind + +The GDPR has many rules for third party assets, so if you don't want to think +about GDPR complaints you can disable every third party asset that is +integrated. + +Some websites using webfonts from third party sites like google. This theme +brings FontAwesome and Roboto(-Slab) directly with it, without having to +integrate them via third party sites. + +### Multilingual support for month names and fixed strings + +#### month names + +Due to the currently unavailable feature for multilingual dates in `.Date` +from Go. It is possible to create a `month.yaml` in the data folder of your +Hugo site root directory. There is also an example file in +`exampleSite/data/`. + +```sh +cat > month.yaml << EOF +1: "Jan" +2: "Feb" +3: "Mar" +4: "Apr" +5: "May" +6: "Jun" +7: "Jul" +8: "Aug" +9: "Sep" +10: "Oct" +11: "Nov" +12: "Dec" +EOF +``` + +#### fixed strings + +There are some fixed strings in the html files that normally uses only the set +language. But if you create a folder `i18n/` in the root directory of your +hugo site and copy the `en.yaml` that comes with the theme you can edit the +fixed strings to your liking. Don't forget to also set +`defaultContentLanguage = "en"` to the new language. + +```sh +mkdir i18n +cd i18n +cp ../themes/hugo-vitae/i18n/en.yaml en.yaml +# Edit the new language file +``` + +### FontAwesome for social icons + +FontAwesome is mainly used for the icons of the social navbar in the top right +corner of the theme. In the config of your Hugo website there is a param +called `icon` for the `params.social` section. I could look like this: + +```toml +[[params.social]] +name = "Github" +icon = "fab fa-github" +url = "https://github.com/dataCobra/hugo-vitae" +``` + +On the [FontAwesome](https://fontawesome.com) website, you can look up every +free icon and also the information you need to put into this `icon` param. + +### Site configuration options + +All configuration options can be looked up in the `exampleSite/config.toml`. + +### Front matter options + +**math(bool)** + +Add math typesetting with KaTeX to the content page. + +**author(string) and authorlink(string)** + +Add author of a page and if you want, add a link to the author. + +**nofeed(bool)** + +Don't add page to RSS. + +**notaxonomy(list)** + +Disable specific taxonomies for a page. + +**disqus(bool)** + +Enable/Disable Disqus for this specific page. + +**hidden(bool)** + +Hide page from the mainSection of the homepage. + +**norobots(bool)** + +Disallow page in robots.txt for search engines. + ## Credits * [hugo-ink](https://github.com/knadh/hugo-ink) from which Vitae was forked -* [freepik](https://www.freepik.com) for the robot avatar +* [freepik](https://www.freepik.com) for the avatar * [google](https://fonts.google.com/specimen/Roboto) for the roboto fonts * [fontawesome](https://fontawesome.com) for providing amazing icons |