Muwu User Guide

2

Before You Begin

2.1

Requirements

  • Ruby version 3.2 or greater
  • a command line interface
  • a text editor of your choice

2.2

Learn Markdown

Muwu reads Markdown syntax. Markdown is easy to learn, however, a full discussion is beyond the scope of this guide.

For more information, see the following sources:

Haml Option

Muwu can also read Haml files.

Information is available at haml.info.

2.3

Installing Muwu

To download the Muwu gem, type the following at the command line:

gem install muwu

The following gems will also be downloaded if they are not yet in the local environment:

  • Commonmarker
  • Haml
  • iso-639
  • Motion-Markdown-It
  • Motion-Markdown-It-Plugins
  • SassC

Muwu also uses the following standard Ruby libraries:

  • CGI
  • FileUtils
  • logger
  • YAML