[prev]
[home]
[next]
Muwu User Guide
muwu version
2.3.1
date of this edition
2020-01-02
Contents
1
Introduction
1.1
About Muwu
1.2
Known Limitations
1.3
License and Disclaimer
2
Before You Begin
2.1
Requirements
2.2
Learn Markdown
2.3
Installing Muwu
3
Getting Started
3.1
Creating a Project
3.2
Editing Project Metadata
3.2.1
Reserved Keywords
4
Outlining a Project
4.1
Simple Outline
4.2
Nested Outline
4.3
Directed Outline
4.3.1
Contents
4.3.2
Multiple Documents
4.3.3
Metadata
4.3.4
Navigator
4.3.5
Subcontents
4.3.6
Text
4.3.7
Title
4.4
Headings and Filenames
4.4.1
Implicit
4.4.2
Explicit
4.4.3
Flexible
4.5
Case Sensitivity
5
Inspecting a Project
6
Compiling a Project
7
Concatenating Source Files
8
Project Options
8.1
generate_navigators_automatically
8.2
generate_subcontents_automatically
8.3
html_head_includes_metadata_tags
8.4
html_lang
8.5
html_uses_javascript_navigation
8.6
markdown_allows_raw_html
8.7
markdown_renderer
8.8
outline_text_pathnames
8.9
output_destination
8.10
output_file_css_basename
8.11
output_file_html_basename
8.12
output_file_js_basename
8.13
output_formats
8.14
render_punctuation_smart
8.15
render_section_end_links
8.16
render_section_numbers
8.17
render_sections_distinctly_depth_max
8.18
render_title_section_metadata
8.19
warning_if_parent_heading_lacks_source
9
Styling a Project
10
Troubleshooting a Project
10.1
Projects that Compile
10.1.1
If Content Is Missing
10.1.2
If Formatting Is Incorrect
10.2
Projects that Do Not Compile
10.2.1
Muwu Exceptions
10.2.2
Yaml Exceptions
10.2.3
Sass exceptions
11
Using Muwu Securely
12
Contributing to Muwu
13
Appendices
13.1
Appendix A – Command Line
13.2
Appendix B – Default Project File Tree
13.3
Appendix C – Default Project Options
13.4
Appendix D – Outline Directives
13.5
Appendix E – Outline for this Guide
[prev]
[home]
[next]