diff --git a/README.md b/README.md index 280664d..cb988c1 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@

- + Hugo Coder Logo

@@ -17,42 +17,41 @@ A simple and clean blog theme for [Hugo](https://gohugo.io/). -![](https://github.com/luizdepra/hugo-coder/blob/master/images/screenshot.png) +![](https://github.com/13hannes11/hugo-coder-timeline/blob/master/images/screenshot.png) ## Fork This theme is forked from https://github.com/luizdepra/hugo-coder. +## Custom Config Options + +I added config options for the timeline title and which posts to include in the timeline. +``` + timelineTitle="My Posts" # General timeline title + timelineType="posts" +``` +These can also be changed based on the language: +``` + [languages.pt-br] + languageName = "Português" + ... + timelineTitle = "Meus Artigos" + ... +``` + ## Quick Start -1. Add the repository into your Hugo Project repository as a submodule, `git submodule add https://github.com/luizdepra/hugo-coder.git themes/hugo-coder`. -2. Configure your `config.toml`. You can either use [this minimal configuration](https://github.com/luizdepra/hugo-coder/wiki/Configurations#complete-example) as a base, or look for a complete explanation about all configurations [here](https://github.com/luizdepra/hugo-coder/wiki/Configurations). The [`config.toml`](https://github.com/luizdepra/hugo-coder/blob/master/exampleSite/config.toml) inside the [`exampleSite`](https://github.com/luizdepra/hugo-coder/tree/master/exampleSite) is also a good reference. +1. Add the repository into your Hugo Project repository as a submodule, `https://github.com/13hannes11/hugo-coder-timeline.git themes/hugo-coder-timeline`. +2. Configure your `config.toml`. You can either the [`config.toml`](https://github.com/13hannes11/hugo-coder-timeline/blob/master/exampleSite/config.toml) in the [`exampleSite`](https://github.com/13hannes11/hugo-coder-timeline/tree/master/exampleSite), or use the documentation of the original non forked version. For that use [this minimal configuration](https://github.com/luizdepra/hugo-coder/wiki/Configurations#complete-example) as a base, or look for a complete explanation about all configurations [here](https://github.com/luizdepra/hugo-coder/wiki/Configurations). 3. Build your site with `hugo serve` and see the result at `http://localhost:1313/`. ## Extra Guides * [Multilingual Mode](https://github.com/luizdepra/hugo-coder/wiki/Multilingual-Mode) -## Stackbit - -This theme is ready to import into Stackbit. This theme can be deployed to Netlify and you can connect any headless CMS including Forestry, NetlifyCMS, DatoCMS or Contentful. - -[![Create with Stackbit](https://assets.stackbit.com/badge/create-with-stackbit.svg)](https://app.stackbit.com/create?theme=https://github.com/luizdepra/hugo-coder) - ## License -Coder is licensed under the [MIT license](https://github.com/luizdepra/hugo-coder/blob/master/LICENSE.md). +Coder Timeline is licemsed under [MIT license](https://github.com/13hannes11/hugo-coder-timeline/blob/master/LICENSE.md), exatcly like Coder which ([MIT license](https://github.com/luizdepra/hugo-coder/blob/master/LICENSE.md).) ## Maintenance -This theme is maintained by its author [Luiz de Prá](https://github.com/luizdepra) with the help from these awesome [contributors](CONTRIBUTORS.md). - -## Sponsoring - -If you like my project or it was useful for you, consider supporting its development. Just: - -Buy Me A Coffee - -## Special Thanks - -- Gleen McComb, for his great [article](https://glennmccomb.com/articles/how-to-build-custom-hugo-pagination/) about custom pagination. -- All contributors, for every PR and Issue reported. +This fork is updated by [Hannes F. Kuchelmeister](https://github.com/13hannes11).