Docs adjustments #1

This commit is contained in:
Sören Weber 2021-07-01 14:35:27 +02:00
parent 82bdb24f72
commit e8340249df
No known key found for this signature in database
GPG key ID: 07D17FF580AE7589
7 changed files with 27 additions and 34 deletions

View file

@ -1,11 +1,11 @@
# Hugo Relearn Theme # Hugo Relearn Theme
This repository contains a theme for [Hugo](https://gohugo.io/). A theme for [Hugo](https://gohugo.io/).
Visit the [theme documentation](https://relearn.netlify.app/) to see what is going on. It is actually built with this theme.
[![wercker status](https://app.wercker.com/status/062e9604da64b79944d87434cb63fa53/s/main "wercker status")](https://app.wercker.com/project/byKey/062e9604da64b79944d87434cb63fa53) [![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/tn.png)
## Main features ## Main features
- Automatic Search - Automatic Search
@ -17,7 +17,10 @@ Visit the [theme documentation](https://relearn.netlify.app/) to see what is goi
- List child pages - List child pages
- Mermaid diagram (flowchart, sequence, gantt) - Mermaid diagram (flowchart, sequence, gantt)
- Customizable look and feel and themes variants - Customizable look and feel and themes variants
- Buttons, Tip/Note/Info/Warning boxes, Expand - Buttons, Tip/Note/Info/Warning boxes, Expand, Tabs
- and many more...
Visit the [documentation](https://relearn.netlify.app/) for a demo.
## Installation ## Installation
@ -30,19 +33,17 @@ git clone https://github.com/McShelby/hugo-theme-relearn.git
Check that your Hugo version is minimum `0.25` with `hugo version`. Check that your Hugo version is minimum `0.25` with `hugo version`.
![Overview](https://github.com/McShelby/hugo-theme-relearn/raw/main/images/tn.png)
## Usage ## Usage
- [Visit the documentation](https://relearn.netlify.app/) - [Visit the documentation](https://relearn.netlify.app/)
## Credits
Many thanks to [@vjeantet](https://github.com/vjeantet/) for the fork [docdock](https://github.com/vjeantet/hugo-theme-docdock). The v2 of this theme is mainly based on his work !
## License ## License
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FMcShelby%2Fhugo-theme-relearn.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FMcShelby%2Fhugo-theme-relearn?ref=badge_large) [MIT licensed.](https://en.wikipedia.org/wiki/MIT_License)
## Credits
Many 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.
## Releasing ## Releasing

View file

@ -22,12 +22,12 @@ The HTML to include the heart icon is:
Paste the `<i>` HTML into markup and Font Awesome will load the relevant icon. Paste the `<i>` HTML into markup and Font Awesome will load the relevant icon.
``` ```
Built with <i class="fas fa-heart"></i> from Relearn and Hugo Built with <i class="fas fa-heart"></i> by Relearn and Hugo
``` ```
Which appears as Which appears as
Built with <i class="fas fa-heart"></i> from Relearn and Hugo Built with <i class="fas fa-heart"></i> by Relearn and Hugo
## Customising icons ## Customising icons

View file

@ -5,13 +5,12 @@ disableToc: true
## Contributors ## Contributors
Thanks to them <i class="fas fa-heart"></i> for making Open Source Software a better place !
{{% ghcontributors "https://api.github.com/repos/McShelby/hugo-theme-relearn/contributors?per_page=100" %}} {{% ghcontributors "https://api.github.com/repos/McShelby/hugo-theme-relearn/contributors?per_page=100" %}}
And a 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 [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.
## Packages and libraries ## Packages and libraries
* [mermaid](https://knsv.github.io/mermaid) - generation of diagram and flowchart from text in a similar manner as markdown * [mermaid](https://knsv.github.io/mermaid) - generation of diagram and flowchart from text in a similar manner as markdown
* [font awesome](http://fontawesome.io/) - the iconic font and CSS framework * [font awesome](http://fontawesome.io/) - the iconic font and CSS framework
* [jQuery](https://jquery.com) - The Write Less, Do More, JavaScript Library * [jQuery](https://jquery.com) - The Write Less, Do More, JavaScript Library
@ -23,6 +22,7 @@ And a special thanks to [@matcornic](https://github.com/matcornic) for his work
## Tooling ## Tooling
* [gren](https://github.com/github-tools/github-release-notes) - Releasenotes generator
* [Hugo](https://gohugo.io/) - Static site generator
* [Netlify](https://www.netlify.com) - Continuous deployement and hosting of this documentation * [Netlify](https://www.netlify.com) - Continuous deployement and hosting of this documentation
* [Hugo](https://gohugo.io/) * [Wercker](https://app.wercker.com) - Continous testing

View file

@ -8,7 +8,7 @@
<!-- Place this tag where you want the button to render. --> <!-- Place this tag where you want the button to render. -->
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn/fork" data-icon="octicon-repo-forked" data-show-count="true" aria-label="Fork McShelby/hugo-theme-relearn on GitHub">Fork</a> <a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn/fork" data-icon="octicon-repo-forked" data-show-count="true" aria-label="Fork McShelby/hugo-theme-relearn on GitHub">Fork</a>
<p>Built with <a href="https://github.com/McShelby/hugo-theme-relearn"><i class="fas fa-heart"></i></a> from <a href="https://gohugo.io/">Hugo</a></p> <p>Built with <a href="https://github.com/McShelby/hugo-theme-relearn"><i class="fas fa-heart"></i></a> by <a href="https://gohugo.io/">Hugo</a></p>
</center> </center>
<!-- Place this tag in your head or just before your close body tag. --> <!-- Place this tag in your head or just before your close body tag. -->
<script async defer src="https://buttons.github.io/buttons.js"></script> <script async defer src="https://buttons.github.io/buttons.js"></script>

View file

@ -1 +1 @@
<p>Built with <a href="https://github.com/McShelby/hugo-theme-relearn"><i class="fas fa-heart"></i></a> from <a href="https://gohugo.io/">Hugo</a></p> <p>Built with <a href="https://github.com/McShelby/hugo-theme-relearn"><i class="fas fa-heart"></i></a> by <a href="https://gohugo.io/">Hugo</a></p>

View file

@ -138,14 +138,3 @@ a#logo{
font-weight: bold; font-weight: bold;
margin-top: -2px; margin-top: -2px;
} }
#logo #relearn-logo{
height: 65px;
margin-bottom: -20px;
margin-top: -20px;
width: 65px;
}
#relearn-logo path {
fill: #fff !important;
}

View file

@ -77,10 +77,13 @@ b, strong, label, th {
-moz-transition: all 0.5s ease; -moz-transition: all 0.5s ease;
transition: all 0.5s ease; transition: all 0.5s ease;
} }
#grav-logo { #logo #relearn-logo{
max-width: 60%; height: 65px;
margin-bottom: -20px;
margin-top: -20px;
width: 65px;
} }
#grav-logo path { #relearn-logo path {
fill: #fff !important; fill: #fff !important;
} }
#sidebar { #sidebar {