Muwu User Guide

muwu version
4.0.0
date of this edition
2026-01-17

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 Project Outline
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 Project Actions
5.1 Inspect a Project
5.2 Compile a Project
5.3 Publish a Project
5.4 Sync a Project
5.5 Reset Project Components
5.6 Concatenate Source Files
6 Project Options
6.1 generate_navigators_automatically
6.2 generate_subcontents_automatically
6.3 generate_topic_inner_identifiers
6.4 html_head_includes_metadata_tags
6.5 html_lang
6.6 html_uses_javascript_navigation
6.7 markdown_allows_raw_html
6.8 markdown_renderer
6.9 outline_text_pathnames
6.10 output_destination
6.11 output_file_css_basename
6.12 output_file_html_basename
6.13 output_file_js_basename
6.14 output_formats
6.15 remote_publish
6.16 remote_sync
6.17 render_punctuation_smart
6.18 render_section_end_links
6.19 render_section_numbers
6.20 render_sections_distinctly_depth_max
6.21 render_title_section_metadata
6.22 rsync_options
6.23 warning_if_parent_heading_lacks_source
7 Project Style Sheets
7.1 Learn CSS
7.2 Inner Identifiers
8 Troubleshooting a Project
8.1 Projects that Compile
8.1.1 If Content Is Missing
8.1.2 If Formatting Is Incorrect
8.2 Projects that Do Not Compile
8.2.1 Muwu Exceptions
8.2.2 Yaml Exceptions
8.2.3 Sass exceptions
9 Contributing to Muwu
10 Appendices
10.1 Appendix A – Command Line
10.2 Appendix B – Default Project File Tree
10.3 Appendix C – Default Project Options
10.4 Appendix D – Outline Directives
10.5 Appendix E – Outline for this Guide