-
Notifications
You must be signed in to change notification settings - Fork 0
/
mktechdocs.conf
42 lines (42 loc) · 2.42 KB
/
mktechdocs.conf
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
# The title of your final document
TITLE="Getting Started with MkTechDocs"
# Where MkTechDocs should put the built project. In this case, the output will be copied into "getting_started_pages". MkTechDocs appends "_pages" to avoid confusion.
OUTPUT_FILE_NAME_BASE=getting_started
# Here, select an output format:
#
# html: A single long html page with a toggle-able table of contents at the top
# htmlsimple: A single long html page with static table of contents at the top
# cssframes: Static table of contents on the left, scrollable content in the middle, static header and footer
# htmlmulti: Static landing page with static table of contents on the left. Each section has it's own separate HTML page.
# markdown: Collect everything in master.md into a single markdown file.
# docx: A standard Microsoft Word docx document.
# epub: A epub ebook
# epub3: A epub3 ebook
FORMAT=cssframes
# Select your style.
#
# archwiki: In the style of the Arch Linux Wiki
# github: Like GitHub documentation
# custom: Do your own thing. Start with the sample mktechdocs.css included in this project. Note that if you use this option you must provide a value for CUSTOM_CSS below.
HTML_STYLE=github
# This controls how many levels of headings to include in the table of contents. Here, six levels of headers will be visible.
TABLE_OF_CONTENTS_MAIN_DEPTH=6
# This controls how many levels of headings to include in the table of contents on "sub" pages, which are only applicable when using the "htmlmulti" format.
TABLE_OF_CONTENTS_SUB_DEPTH=3
# If true, headers will automatically contain section numbers.
SECTION_NUMBERS=true
# Put all your images in the following directory so MkTechDocs knows to copy it into the output directory.
IMAGES=./images
# Use a build script to do things both before and after a build. MkTechDocs calls this script if present like:
#
# mybuildscript.sh pre
# mybuildscript.sh post
#
# A typical use of this script is to copy output to some other place like ~/public_html.
BUILD_SCRIPT=mybuildscript.sh
# If you use the "custom" HTML_STYLE, apply the following css file. Leave it empty to use the default.
CUSTOM_CSS=my.css
# You can use your own custom HTML template to build pages. Leave it empty to use a template consisten with FORMAT. This one is for demo purposes.
CUSTOM_TEMPLATE=mytemplate.html
# During the build, MkTechDocs creates many temporary files. You can set this to true if you want to understand why a build is failing.
KEEP_TEMP_FILES=false