No description
Find a file
2025-01-18 01:04:55 -06:00
.config docs: added a project ID 2025-01-18 01:04:55 -06:00
docs feat!: updating dependencies and restructuring project 2025-01-18 00:51:59 -06:00
news feat!: updating dependencies and restructuring project 2025-01-18 00:51:59 -06:00
packages feat!: updating dependencies and restructuring project 2025-01-18 00:51:59 -06:00
.editorconfig feat!: updating dependencies and restructuring project 2025-01-18 00:51:59 -06:00
.envrc feat!: updating dependencies and restructuring project 2025-01-18 00:51:59 -06:00
.eslintrc.yml chore: initial commit to create a monorepo 2020-07-25 01:10:29 -05:00
.gitignore feat!: updating dependencies and restructuring project 2025-01-18 00:51:59 -06:00
.npmignore chore: merging eslint rules 2020-07-25 01:49:47 -05:00
.prettierignore chore: integrated prettier for formatting 2020-07-25 14:05:26 -05:00
flake.lock feat!: updating dependencies and restructuring project 2025-01-18 00:51:59 -06:00
flake.nix feat!: updating dependencies and restructuring project 2025-01-18 00:51:59 -06:00
Justfile feat!: updating dependencies and restructuring project 2025-01-18 00:51:59 -06:00
LICENSE feat: updating licenses 2021-08-14 20:35:41 -05:00
package-lock.json feat!: updating dependencies and restructuring project 2025-01-18 00:51:59 -06:00
package.json feat!: updating dependencies and restructuring project 2025-01-18 00:51:59 -06:00
README.md feat!: updating dependencies and restructuring project 2025-01-18 00:51:59 -06:00
snippet.md feat!: updating dependencies and restructuring project 2025-01-18 00:51:59 -06:00
TASKS.md feat!: updating dependencies and restructuring project 2025-01-18 00:51:59 -06:00

MfGames Writing Tools

⚠ 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.