This page permanently redirects to gemini://mfgames.com/mfgames-writing-js/.

MfGames Writing Tools

=> Up a Level

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[1] for this project has changed as did the primary location for the source code.

=> 1: https://mfgames.com/mfgames-writing-js/

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[2] 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[3] to create EPUB2 files or @mfgames-writing/weasyprint-format[4] for making PDFs using WeasyPrint[5].

=> 2: https://www.npmjs.com/package/@mfgames-writing/format | 3: https://www.npmjs.com/package/@mfgames-writing/epub2-format | 4: https://www.npmjs.com/package/@mfgames-writing/weasyprint-format | 5: https://weasyprint.org/

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

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

=> 6: ./docs/publication.md

Documentation

The documentation for this package is in the same repository[7] 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.

=> 7: ./docs/

Metadata

Categories:

=> MfGames Writing Tools

Footer

Below are various useful links within this site and to related sites (not all have been converted over to Gemini).

=> Categories

=> D. Moonfire | Fedran | The Moonfires

=> HTML | Atom Feed

Proxy Information
Original URL
gemini://mfgames.com/mfgames-writing-js
Status Code
Success (20)
Meta
text/gemini;lang=en-US
Capsule Response Time
1006.295202 milliseconds
Gemini-to-HTML Time
2.177818 milliseconds

This content has been proxied by September (3851b).