From e8340249df9a7004d8961aa1f2173e77d5d7233c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Weber?= Date: Thu, 1 Jul 2021 14:35:27 +0200 Subject: [PATCH] Docs adjustments #1 --- README.md | 23 ++++++++++--------- exampleSite/content/cont/icons.en.md | 4 ++-- exampleSite/content/credits.en.md | 10 ++++---- exampleSite/layouts/partials/menu-footer.html | 2 +- layouts/partials/menu-footer.html | 2 +- static/css/theme-relearn.css | 11 --------- static/css/theme.css | 9 +++++--- 7 files changed, 27 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 864c884349..7b12e9e540 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # Hugo Relearn Theme -This repository contains 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. +A 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/tn.png) + ## Main features - Automatic Search @@ -17,7 +17,10 @@ Visit the [theme documentation](https://relearn.netlify.app/) to see what is goi - List child pages - Mermaid diagram (flowchart, sequence, gantt) - 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 @@ -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`. -![Overview](https://github.com/McShelby/hugo-theme-relearn/raw/main/images/tn.png) - ## Usage - [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 -[![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 diff --git a/exampleSite/content/cont/icons.en.md b/exampleSite/content/cont/icons.en.md index d34a1176eb..954a7da542 100644 --- a/exampleSite/content/cont/icons.en.md +++ b/exampleSite/content/cont/icons.en.md @@ -22,12 +22,12 @@ The HTML to include the heart icon is: Paste the `` HTML into markup and Font Awesome will load the relevant icon. ``` -Built with from Relearn and Hugo +Built with by Relearn and Hugo ``` Which appears as -Built with from Relearn and Hugo +Built with by Relearn and Hugo ## Customising icons diff --git a/exampleSite/content/credits.en.md b/exampleSite/content/credits.en.md index a9768ae216..c3725d2ee8 100644 --- a/exampleSite/content/credits.en.md +++ b/exampleSite/content/credits.en.md @@ -5,13 +5,12 @@ disableToc: true ## Contributors -Thanks to them for making Open Source Software a better place ! - {{% 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 + * [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 * [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 +* [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 -* [Hugo](https://gohugo.io/) - +* [Wercker](https://app.wercker.com) - Continous testing diff --git a/exampleSite/layouts/partials/menu-footer.html b/exampleSite/layouts/partials/menu-footer.html index a3968b36e0..1154502328 100644 --- a/exampleSite/layouts/partials/menu-footer.html +++ b/exampleSite/layouts/partials/menu-footer.html @@ -8,7 +8,7 @@ Fork -

Built with from Hugo

+

Built with by Hugo

diff --git a/layouts/partials/menu-footer.html b/layouts/partials/menu-footer.html index 77d1b8e913..8e7d496d5f 100644 --- a/layouts/partials/menu-footer.html +++ b/layouts/partials/menu-footer.html @@ -1 +1 @@ -

Built with from Hugo

+

Built with by Hugo

diff --git a/static/css/theme-relearn.css b/static/css/theme-relearn.css index 467315ae1f..05d0f74bda 100644 --- a/static/css/theme-relearn.css +++ b/static/css/theme-relearn.css @@ -138,14 +138,3 @@ a#logo{ font-weight: bold; margin-top: -2px; } - -#logo #relearn-logo{ - height: 65px; - margin-bottom: -20px; - margin-top: -20px; - width: 65px; -} - -#relearn-logo path { - fill: #fff !important; -} diff --git a/static/css/theme.css b/static/css/theme.css index 98a5584255..de123405ba 100644 --- a/static/css/theme.css +++ b/static/css/theme.css @@ -77,10 +77,13 @@ b, strong, label, th { -moz-transition: all 0.5s ease; transition: all 0.5s ease; } -#grav-logo { - max-width: 60%; +#logo #relearn-logo{ + height: 65px; + margin-bottom: -20px; + margin-top: -20px; + width: 65px; } -#grav-logo path { +#relearn-logo path { fill: #fff !important; } #sidebar {