Muwu User Guide

12

Appendices

12.1

Appendix A – Command Line

muwu

Show the version number and a summary of commands.

muwu compile

Compile all parts of the project.

muwu compile css

Compile any CSS files.

muwu compile html

Compile any HTML files.

muwu compile html [index]

Compile only the HTML file with the given index number.

muwu compile js

Compile any JS files.

muwu concat

Concatenate all source files into a new, single markdown file. Includes section numbers and headings.

muwu help

Show the version number and a summary of commands.

muwu help [command]

Show more detailed help for the given command.

muwu inspect

Display the project options, the compiler manifest, index numbers of HTML files, and any exceptions.

muwu new

Create a new project as a subdirectory within the current working directory.

muwu reset css

Return the initial CSS files to their original contents.

12.2

Appendix B – Default Project File Tree

{parent directory}/
|-{project directory}/
  |-config/
  | |-css/
  |   |-base/
  |   | |-html_elements.scss
  |   | |-index.scss
  |   | |-section_muwu.scss
  |   | |-section_muwu_contents.scss
  |   | |-section_muwu_metadata.scss
  |   | |-section_muwu_navigator.scss
  |   | |-section_muwu_subcontents.scss
  |   | |-section_muwu_text.scss
  |   | |-section_muwu_title.scss
  |   |-colors/
  |   | |-dark.scss
  |   | |-index.scss
  |   | |-light.scss
  |   |-extensions/
  |   | |-index.scss
  |   |-index.scss
  |-images/
  |-text/
  |-metadata.yml
  |-options.yml
  |-outline.yml
12.3

Appendix C – Default Project Options

generate_navigators_automatically: true
generate_subcontents_automatically: false
html_head_includes_metadata_tags: true
html_uses_javascript_navigation: false
markdown_allows_raw_html: true
markdown_renderer: commonmarker
outline_text_pathnames: flexible
output_destination: file
output_file_css_basename: nil
output_file_html_basename: index
output_file_js_basename: nil
output_formats: html, css, js
render_punctuation_smart: true
render_section_end_links: contents, top
render_section_numbers: true
render_sections_distinctly_depth_max: nil
render_title_section_metadata: title, subtitle, author
warning_if_parent_heading_lacks_source: true
12.4

Appendix D – Outline Directives

contents

Create a table of contents for the main text block.

- contents
contents [name]

Create a table of contents for the text block named [name].

- contents introduction
navigator

Create a navigator with links for home, next, and previous document.

Requires an outline with multiple documents.

- navigator
metadata

Show all metadata attributes

- metadata
metadata: [attributes]

Show the metadata attributes indicated by [attributes].

- metadata:
  - copyright
  - editor
  - publisher
subcontents

Create a table of contents only for the current document.

Requires an outline with multiple documents.

- subcontents
text:

Create a main text block.

- text:
  - Monday
text [name]:

Create a text block named [name].

- text introduction:
  - dedication
title

Create a title block.

- title
title: [attributes]

Create a title block that includes metadata values for [attributes].

- title:
  - title
  - subtitle
  - author
12.5

Appendix E – Outline for this Guide

This user guide was prepared and compiled with Muwu.

outline.yml

---
- Title:
  - title
- Metadata:
  - muwu version
  - date of this edition
- Contents
---
- Introduction:
  - About Muwu
  - Known Limitations
  - License and Disclaimer
---
- Before You Begin:
  - Requirements
  - Learn Markdown
  - Installing Muwu
---
- Getting Started:
  - Creating a Project
  - Editing Project Metadata:
    - Reserved Keywords
---
- Outlining a Project:
  - Simple Outline
  - Nested Outline
  - Directed Outline:
    - Contents:
      - Single Text Section
      - Multiple Text Sections
    - Document
    - Metadata:
      - Date of This Edition
    - Navigator
    - Subcontents
    - Text:
      - Single Text Section
      - Multiple Text Sections
    - Title
  - Headings and Filenames:
    - Implicit:
      - Implicit Filenames with Multiple Text Sections
    - Explicit
    - Flexible
  - Case Sensitivity
---
- Inspecting a Project
- Compiling a Project
- Concatenating Source Files
---
- Project Options:
  - generate_navigators_automatically
  - generate_subcontents_automatically
  - html_includes_metadata_tags
  - html_uses_javascript_navigation
  - markdown_allows_raw_html
  - markdown_renderer
  - outline_text_pathnames
  - output_destination
  - output_file_css_basename
  - output_file_html_basename
  - output_file_js_basename
  - output_formats
  - render_punctuation_smart
  - render_section_end_links
  - render_section_numbers
  - render_sections_distinctly_depth_max
  - render_title_section_metadata
  - warning_if_parent_heading_lacks_source
---
- Troubleshooting a Project:
  - Projects that Compile:
    - If Content Is Missing
    - If Formatting Is Incorrect
  - Projects that Do Not Compile:
    - Muwu Exceptions:
      - is this a muwu project folder
      - stdout multiple documents
      - stdout multiple formats
    - YAML Exceptions
    - Sass Exceptions
---
- Using Muwu Securely
- Contributing to Muwu
---
- Appendices:
  - command line
  - default project file tree
  - default project options
  - outline directives
  - outline for this guide