blob: a91633321ee21b507a94fddb47f4ba03cb101a06 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
# Adam & Eve
I migrated my wiki from [Dokuwiki](https://www.dokuwiki.org/) to [Hugo](http://gohugo.io/) and created a new theme to reconcile both: Adam & Eve was born.
This theme is special: **it comes with its more simple formal dress**.
Why ? Because it is:
* simple
* clean
* responsive
I was enormously inspired by [Note Plugin](https://www.dokuwiki.org/plugin:note) for notes. And [Dokuwiki](https://www.dokuwiki.org/) for external and internal links.
## Screenshot
This is a single page from the wiki, showing:
* a simple menu to go to the homepage
* a table of contents
* internal shortcode (the green link)
* note shortcode (the 4 models)
* nolink shortcode (the red link)
* remote shortcode (the link with a globe before)
## Installation
In your Hugo root folder, do something like:
```bash
mkdir themes
cd themes
git clone https://github.com/blankoworld/hugo_theme_adam_eve.git
```
Check [Hugo Installation Guide](https://gohugo.io/getting-started/installing/) for more information.
## Getting Started
### The config file
You can either copy **config.toml.example** from this repository to your Hugo root directory (and rename it **config.toml**). Or copy those included in *exampleSite* directory.
Just adapt the content to your needs.
### The _index.md files
_index.md files are used to display content of a specific category. A category is a directory you add in **content** directory.
Check **exampleSite** directory content for some examples.
**Tip:** If you need to make a link to a category called design, to go to its **_index.md** file, you need to create an empty **index.md** file and make a link like that:
```
[My category]({{< relref "mycategory/index.md" >}})
```
## Special features
### Specific links
In order to have a similar behaviour to [Dokuwiki](https://www.dokuwiki.org/), I created 3 types of links:
* Remote link: display a little globe at the left. Permit to reader immediately understand that it's a remote link
* Internal link: between page that are in your wiki
* Word without link: sometimes you planned to make a link on a word. To not forget, I created a specific **nolink** word to make a specific display
Let's have some example.
For remote links:
```
{{< remote "Wiki" "http://fr.wikipedia.org/wiki/Wiki" >}}
```
With remote shortcode, you have many other possibilities by playing with parameters:
```
{{< remote "Panda" "https://best.panda.domain.tld" "What a panda looks like" >}}
```
which add a **title** to your link (when user keep cursor on it).
```
{{< remote "http://perdu.com/" >}}
```
which display the link at it is. But with the globe before ;)
For internal links:
```
{{< internal "Magic potion" "section/my_internal_page.md" >}}
```
And for nolink word:
```
{{< nolink "How to create a flower bread" "page/I/want/to/create/later.md" >}}
```
**Tip:** Check **exampleSite/content/_index.md** file to have some examples.
### Notes
Display a sidebar with a specific background color to show readers something important.
We have 4 sidebar models:
* warning (red)
* important (yellow)
* tip (green)
* normal (blue)
Example:
```
{{% note warning %}}
Pay attention to read this **entire page** before applying what you read!
{{% /note %}}
```
### Homepage menu
By default a menu is displayed on Homepage. You can disable it. Use `nohomebar` in **config.toml** like this:
```ini
[params]
nohomebar = true
```
### Homepage posts list
By default a list of post from `post` directory is shown on Homepage. You can disable it. Use `NoHomepagePostList` in **config.toml** like this:
```ini
[params]
NoHomepagePostList = true
```
## Contributing
Did you found a bug or got an idea for a new feature? Feel free to use the [issue tracker](//github.com/blankoworld/hugo_theme_adam_eve/issues) to let me know. Or make directly a [pull request](//github.com/blankoworld/hugo_theme_adam_eve/pulls).
## License
This theme is released under the MIT License. For more information read the [License](//github.com/blankoworld/hugo_theme_adam_eve/blob/master/LICENSE.md).
|
