MfGames Writing Tools

News

• 2021-02-03 Added @mfgames-writing/opf and @mfgames-writing/ncx
• 2025-01-12 Moved Repository to MfGames
• 2020-07-26 Switched to a monorepo and rehosted on SourceHut
• Blog Archives

Introduction

⚠ 2025-01-20: The home page for this project has changed as did the primary location for the source code.

The mfgames-writing-js is a set of tools and utilities for working with novels, stories, and related prose written in Markdown files with a YAML header. It integrated with the Node ecosystem and includes functionality to compile the results into PDF, EPUB, MOBI, and HTML formats. It is well suited for working with continual integration servers.

🛈 2025-01-20: This is the Javascript edition of the mfgames-writing tools. There have been many iterations of those tools over the years, but this is the currently the activately maintained version.

Installation

@mfgames-writing/format package is needed for generating documents along with one or more format packages, such as [@mfgames]. An individual format is also needed, such as @mfgames-writing/epub2-format to create EPUB2 files or @mfgames-writing/weasyprint-format for making PDFs using WeasyPrint.

npm install @mfgames-writing/format @mfgames-writing/epub2-format

Then a publication file (such as publication.json or publication.yaml) is created in the top-level folder to configure how the output will be generated.

Documentation

The documentation for this package is in the same repository as the source, tying the two together. If you are looking for details for an older release, use the documentation from that commit for more information.