13hannes11/hugo-coder-timeline
1
0
Fork 0
mirror of https://github.com/13hannes11/hugo-coder-timeline.git synced 2024-09-04 00:50:58 +02:00
Code Issues Projects Releases Wiki Activity

Update readme to point to links of this repository

Browse Source 
The image links have been updated and moreover added config options are documented.
Some sections from the original readme are deleted.
This commit is contained in:
Hannes Kuchelmeister
2021-02-16 20:03:07 +01:00
committed by GitHub
parent d34ad31cf6
commit 28b5021a41
1 changed files with 22 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@@ -9,7 +9,7 @@
</p>
<p align="center">
<a href="https://github.com/luizdepra/hugo-coder">
<a href="https://github.com/13hannes11/hugo-coder-timeline">
<img src="images/logos/logotype-a.png" alt="Hugo Coder Logo" width="600px" height="184px">
</a>
</p>
@@ -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:
<a href="https://www.buymeacoffee.com/luizdepra" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-green.png" alt="Buy Me A Coffee" height="41" width="174"></a>
## 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).