Dungeon Notes Writer

Write D & D 5e adventures in markdown

The dungeon notes writer is a cli tool that supports writing D & D 5e adventures in markdown by providing a local web-based editor for authoring the adventure, saving as markdown files in a local directory and generating html from saved files.

• Dungeon Notes Writer
• Usage
• Commands
• Development

Usage

$ npm install -g @dungeon-notes/writer
$ dnwriter COMMAND
running command...
$ dnwriter (-v|--version|version)
@dungeon-notes/writer/0.3.3 darwin-x64 node-v14.15.3
$ dnwriter --help [COMMAND]
USAGE
  $ dnwriter COMMAND
...

Commands

• dnwriter build [FILE]
• dnwriter help [COMMAND]
• dnwriter init [PATH]
• dnwriter serve [PATH]

dnwriter build [FILE]

build a static site from the repo

USAGE
  $ dnwriter build [FILE]

OPTIONS
  -h, --help       show CLI help
  -p, --path=path  [default: .]

See code: lib/commands/build.js

dnwriter help [COMMAND]

display help for dnwriter

USAGE
  $ dnwriter help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

dnwriter init [PATH]

Setup a new notes repo

USAGE
  $ dnwriter init [PATH]

OPTIONS
  -h, --help  show CLI help

See code: lib/commands/init.js

dnwriter serve [PATH]

serves the notes editor

USAGE
  $ dnwriter serve [PATH]

OPTIONS
  -h, --help       show CLI help
  -p, --port=port  [default: 9898] the port to serve on

EXAMPLE
  $ dnwriter serve

See code: lib/commands/serve.js

Development

The graphql server provided by the serve command can be run under nodemon with:

yarn dev