nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-27 01:33:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: rework README.md #34

Browse source 
to avoid duplication of information
This commit is contained in:
Sören Weber 2021-08-23 18:54:02 +02:00
parent 4e93b3a5fe
commit 2ae4a58a2f
No known key found for this signature in database
GPG key ID: 07D17FF580AE7589
1 changed files with 13 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -1,11 +1,15 @@
# Hugo Relearn Theme # Hugo Relearn Theme
A theme for [Hugo](https://gohugo.io/). A documentation theme for [Hugo](https://gohugo.io/).
[![wercker status](https://app.wercker.com/status/062e9604da64b79944d87434cb63fa53/s/main "wercker status")](https://app.wercker.com/project/byKey/062e9604da64b79944d87434cb63fa53)
![Overview](https://github.com/McShelby/hugo-theme-relearn/raw/main/images/screenshot.png) ![Overview](https://github.com/McShelby/hugo-theme-relearn/raw/main/images/screenshot.png)
## Motivation
The theme initially was a fork of [hugo-theme-learn](https://github.com/matcornic/hugo-theme-learn) with the aim of fixing long outstanding bugs and adepting to latest Hugo features.
As far as possible the theme tries to be a drop-in replacement for hugo-theme-learn. The documentation provides instructions on how to achieve the best compatiblity while still benefitting from bug fixes and new features.
## Main features ## Main features
- Automatic Search - Automatic Search
@ -19,33 +23,24 @@ A theme for [Hugo](https://gohugo.io/).
- Customizable look and feel and themes variants - Customizable look and feel and themes variants
- Buttons, Tip/Note/Info/Warning boxes, Expand, Tabs - Buttons, Tip/Note/Info/Warning boxes, Expand, Tabs
Visit the [documentation](https://relearn.netlify.app/) for a demo.
## Installation ## Installation
Navigate to your themes folder in your Hugo site and use the following commands: Visit the [installation instructions](https://relearn.netlify.app/basics/installation) to learn how to setup the theme in your Hugo installation.
```shell
cd themes/
git clone https://github.com/McShelby/hugo-theme-relearn.git
```
Check that your Hugo version is minimum `0.25` with `hugo version`.
## Usage ## Usage
- [Visit the documentation](https://relearn.netlify.app/) Visit the [documentation](https://relearn.netlify.app/) to learn about all available features and how to use them.
## Changelog ## Changelog
[The changelog can be seen here.](https://github.com/McShelby/hugo-theme-relearn/blob/main/CHANGELOG.md) See the [changelog](https://github.com/McShelby/hugo-theme-relearn/blob/main/CHANGELOG.md) for a complete list of releases.
## License ## License
[MIT licensed.](https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE) This project is licensed under the [MIT License](https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE).
## Credits ## Credits
Many thanks to [everyone who has contributed](https://github.com/McShelby/hugo-theme-relearn/graphs/contributors) to this project. Special thanks to [everyone who has contributed](https://github.com/McShelby/hugo-theme-relearn/graphs/contributors) to this project.
Special thanks to [@matcornic](https://github.com/matcornic) for his work on [learn](https://github.com/matcornic/hugo-theme-learn) and [@vjeantet](https://github.com/vjeantet) for his work on [docdock](https://github.com/vjeantet/hugo-theme-docdock), which hugo-theme-relearn is based on. Many thanks to [@matcornic](https://github.com/matcornic) for his work on [hugo-theme-learn](https://github.com/matcornic/hugo-theme-learn).