mfgames-writing-js/mfgames-writing-js
1
0
Fork 0
Code Issues 2 Pull requests Projects Releases Packages Activity Actions
No description
764 commits 2 branches 0 tags 5.3 MiB
  • TypeScript 84%
  • HTML 4.9%
  • SCSS 4.7%
  • Lua 1.9%
  • Shell 1.7%
  • Other 2.8%
Find a file
Exact
D. Moonfire 9e71278b10 fix(format): clarify messages for merging
2026-01-19 22:47:09 -06:00
.config feat: bumped up dependencies, reformatted a lot 2026-01-18 20:11:23 -06:00
.local/bin test: introduced a hyphen test and updating formats 2026-01-17 20:45:31 -06:00
docs docs: adding project ID 2025-02-22 21:03:36 -06:00
news docs: updating news 2026-01-19 02:24:17 -06:00
packages fix(format): clarify messages for merging 2026-01-19 22:47:09 -06:00
tests/scripts fix: tweaking image generation 2026-01-19 12:05:22 -06:00
.editorconfig refactor: switched flake to use flake-parts 2026-01-17 19:03:38 -06:00
.envrc test: introduced a hyphen test and updating formats 2026-01-17 20:45:31 -06:00
.gitignore refactor: switched flake to use flake-parts 2026-01-17 19:03:38 -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!: pipelines can be excluded 2026-01-17 21:41:20 -06:00
flake.nix fix(docx-format): fixed where outputDirectory is nested 2026-01-17 23:26:56 -06:00
Justfile fix: making sure edition selection works 2026-01-19 02:14:23 -06:00
LICENSE feat: updating licenses 2021-08-14 20:35:41 -05:00
package-lock.json fix(format): clarify messages for merging 2026-01-19 22:47:09 -06:00
package.json feat: bumped up dependencies, reformatted a lot 2026-01-18 20:11:23 -06:00
README.md docs: adding project ID 2025-02-22 21:03:36 -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

README.md

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

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.