doc: Build using a Makefile
[noc.git] / doc / ikiwiki.setup
1 # IkiWiki::Setup::Yaml - YAML formatted setup file
2 #
3 # Setup file for ikiwiki.
4 #
5 # Passing this to ikiwiki --setup will make ikiwiki generate
6 # wrappers and build the wiki.
7 #
8 # Remember to re-run ikiwiki --setup any time you edit this file.
9 #
10 # name of the wiki
11 wikiname: Realraum NOC -- documentation
12 # contact email for wiki
13 adminemail: noc@realraum.at
14 # where the source of the wiki is located
15 srcdir: .
16 # where to build the wiki
17 destdir: dest/
18
19 # base url to the wiki; keep empty for local builds (with relpaths)
20 url: ''
21 # url to the ikiwiki.cgi; keep empty for disabling
22 cgiurl: ''
23 # Do not autopush
24 gitorigin_branch: ''
25
26 # rcs backend to use
27 rcs: git
28 # plugins to add to the default configuration
29 add_plugins:
30 - html
31 - img
32 - pagetemplate
33
34 # plugins to disable
35 disable_plugins:
36 - htmlscrubber
37
38 # additional directory to search for template files
39 templatedir: /usr/share/ikiwiki/templates
40
41 # base wiki source location
42 underlaydir: /usr/share/ikiwiki/basewiki
43
44 # use '!'-prefixed preprocessor directives?
45 prefix_directives: '1'
46
47 # use page/index.mdwn source files
48 indexpages: '0'
49
50 # generate HTML5?
51 html5: '1'
52
53 # extension to use for html files
54 htmlext: html
55
56 # strftime format string to display date
57 timeformat: '%c'
58
59 # UTF-8 locale to use
60 locale: en_US.UTF-8
61
62 # how many backlinks to show before hiding excess (0 to show all)
63 numbacklinks: '10'
64
65 # attempt to hardlink source files? (optimisation for large files)
66 hardlink: '0'