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
|
# Adam & Eve
I migrated my [Dokuwiki](https://www.dokuwiki.org/) to [Hugo](http://gohugo.io/) and created a new theme 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
For you to create a Wiki, I created Hugo shortcodes:
* for external link
* for internal link
* for word you planned to use to create a new wiki single page
* to create different notes:
* important note
* an alert
* tip box
* or normal note
After that, if you need to dress it with more CSS, you're free :smile:.
# Link behaviour in content
For more information about shortcodes, check [Shortcode section](#shortcodes).
## Behaviour 1 (default): all links are internal one and you will use remote shortcode
By default all links are blue (table of contents, menu, etc.). And all links from the content are green (as internal one).
This mean you will probably use 'remote' shortcode for external links.
Indeed you can use 'internal' shortcode too. But all links from main content is green by default.
## Behaviour 2: all links are normal and you will use internal and remote shortcode to define all links
If you want to consider all links as normal, and want to define yourself which link is external, which other one is internal, you need to comment these line in **static/css/main.css**:
```
main a:active, main a:link, main a:visited, main a:hover {
color: #080; // comment this line if you planned to use 'internal' shortcode
}
```
Add **//** at the beginning of each line will be enough.
# Shortcodes
To use wiki functionnalities, I create some shortcodes.
## nolink
Display a word you want to use later to create a new page of your Wiki.
In Dokuwiki it was CamelCase behaviour that show you a word in red.
Example:
```
{{< nolink "How to create a flower bread" "page/I/want/to/create/later.md" >}}
```
## remote
Display a link with a globe before so that readers know they will go away your wiki.
Example:
```
{{< 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 ;)
## internal
This shortcode will use `relref` Hugo command to create a relative link to the given page.
```
{{< internal "Magic potion" "section/my_internal_page.md" >}}
```
## note
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 %}}
```
# Screenshots
## Single page
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)
## Blockquote and code
You can use code syntaxic coloration (with [pygmentize as explained in Hugo documentation](https://gohugo.io/extras/highlighting/)).
|
