Skip to content

metamagic-games/handbooker

Repository files navigation

handbooker

npm version

Turn markdown into a Player's Handbook-style document.

Based on Homebrewery's stylesheet.


Usage

For a working example, take a look at handbooker-sample-project

  const { handbooker, } = require("handbooker");
  
  const target = "./rulebook.md";
  
  const destination = "./rulebook.pdf";

  const options = {
    "debug": true,
    "style": "dnd",
    "printOptions": {
      displayHeaderFooter: false,
    },
  };

  handbooker( target, destination, options);

Combining multiple markdown files

To merge many different Markdown files, simply replace:

    const target = "./rulebook.md";

With:

    const target = [ "./rulebook.md", "./rulebook2.md", ];

Styles

This package can support creation of documents in the style of several different games.

Included styles

The default style is the 5e D&D Player's Handbook. Feel free to add other stylesheets to this package.

To select from an included style sheet:

  const options = {
    "style": "dnd",
  };

Custom styles

To use your own:

  const options = {
    "customStyles": "your/custom/stylesheet.css",
  };

Why not just use Homebrewery?

Homebrewery is a fantastic tool, and this project wouldn't be possible without their fantastic stylesheet. However, Homebrewery doesn't make collaboration and tracking changes to your document easy. If you're just working alone, and you're not used to working with git, npm, or Markdown, this might not be the tool for you.

Contributing

If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are welcome!