Skip to content

Commit e834024

Browse files
committed
Docs adjustments #1
1 parent 82bdb24 commit e834024

File tree

7 files changed

+26
-33
lines changed

7 files changed

+26
-33
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Hugo Relearn Theme
22

3-
This repository contains a theme for [Hugo](https://gohugo.io/).
4-
5-
Visit the [theme documentation](https://relearn.netlify.app/) to see what is going on. It is actually built with this theme.
3+
A theme for [Hugo](https://gohugo.io/).
64

75
[![wercker status](https://app.wercker.com/status/062e9604da64b79944d87434cb63fa53/s/main "wercker status")](https://app.wercker.com/project/byKey/062e9604da64b79944d87434cb63fa53)
86

7+
![Overview](https://github.com/McShelby/hugo-theme-relearn/raw/main/images/tn.png)
8+
99
## Main features
1010

1111
- Automatic Search
@@ -17,7 +17,10 @@ Visit the [theme documentation](https://relearn.netlify.app/) to see what is goi
1717
- List child pages
1818
- Mermaid diagram (flowchart, sequence, gantt)
1919
- Customizable look and feel and themes variants
20-
- Buttons, Tip/Note/Info/Warning boxes, Expand
20+
- Buttons, Tip/Note/Info/Warning boxes, Expand, Tabs
21+
- and many more...
22+
23+
Visit the [documentation](https://relearn.netlify.app/) for a demo.
2124

2225
## Installation
2326

@@ -30,19 +33,17 @@ git clone https://github.com/McShelby/hugo-theme-relearn.git
3033

3134
Check that your Hugo version is minimum `0.25` with `hugo version`.
3235

33-
![Overview](https://github.com/McShelby/hugo-theme-relearn/raw/main/images/tn.png)
34-
3536
## Usage
3637

3738
- [Visit the documentation](https://relearn.netlify.app/)
3839

39-
## Credits
40+
## License
4041

41-
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 !
42+
[MIT licensed.](https://en.wikipedia.org/wiki/MIT_License)
4243

43-
## License
44+
## Credits
4445

45-
[![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)
46+
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.
4647

4748
## Releasing
4849

exampleSite/content/cont/icons.en.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ The HTML to include the heart icon is:
2222
Paste the `<i>` HTML into markup and Font Awesome will load the relevant icon.
2323

2424
```
25-
Built with <i class="fas fa-heart"></i> from Relearn and Hugo
25+
Built with <i class="fas fa-heart"></i> by Relearn and Hugo
2626
```
2727

2828
Which appears as
2929

30-
Built with <i class="fas fa-heart"></i> from Relearn and Hugo
30+
Built with <i class="fas fa-heart"></i> by Relearn and Hugo
3131

3232
## Customising icons
3333

exampleSite/content/credits.en.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,12 @@ disableToc: true
55

66
## Contributors
77

8-
Thanks to them <i class="fas fa-heart"></i> for making Open Source Software a better place !
9-
108
{{% ghcontributors "https://api.github.com/repos/McShelby/hugo-theme-relearn/contributors?per_page=100" %}}
119

12-
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.
10+
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.
1311

1412
## Packages and libraries
13+
1514
* [mermaid](https://knsv.github.io/mermaid) - generation of diagram and flowchart from text in a similar manner as markdown
1615
* [font awesome](http://fontawesome.io/) - the iconic font and CSS framework
1716
* [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
2322

2423
## Tooling
2524

25+
* [gren](https://github.com/github-tools/github-release-notes) - Releasenotes generator
26+
* [Hugo](https://gohugo.io/) - Static site generator
2627
* [Netlify](https://www.netlify.com) - Continuous deployement and hosting of this documentation
27-
* [Hugo](https://gohugo.io/)
28-
28+
* [Wercker](https://app.wercker.com) - Continous testing

exampleSite/layouts/partials/menu-footer.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<!-- Place this tag where you want the button to render. -->
99
<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>
1010

11-
<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>
11+
<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>
1212
</center>
1313
<!-- Place this tag in your head or just before your close body tag. -->
1414
<script async defer src="https://buttons.github.io/buttons.js"></script>

layouts/partials/menu-footer.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +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>
1+
<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>

static/css/theme-relearn.css

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -138,14 +138,3 @@ a#logo{
138138
font-weight: bold;
139139
margin-top: -2px;
140140
}
141-
142-
#logo #relearn-logo{
143-
height: 65px;
144-
margin-bottom: -20px;
145-
margin-top: -20px;
146-
width: 65px;
147-
}
148-
149-
#relearn-logo path {
150-
fill: #fff !important;
151-
}

static/css/theme.css

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,13 @@ b, strong, label, th {
7777
-moz-transition: all 0.5s ease;
7878
transition: all 0.5s ease;
7979
}
80-
#grav-logo {
81-
max-width: 60%;
80+
#logo #relearn-logo{
81+
height: 65px;
82+
margin-bottom: -20px;
83+
margin-top: -20px;
84+
width: 65px;
8285
}
83-
#grav-logo path {
86+
#relearn-logo path {
8487
fill: #fff !important;
8588
}
8689
#sidebar {

0 commit comments

Comments
 (0)