Tool for editing Valence UI-themed sites generated from Markdown

You'll probably want to install this globally with -g. Run this:

npm install -g https://github.com/Brightspace/doctool

Well run the tool on the example project in this repo. First, clone the repo

git clone https://github.com/Brightspace/doctool
cd doctool

Next, start doctool in interactive mode:

doctool --interactive example

Your browser will open up a window to the rendered webpage. You can edit files in your favourite editor and the pages will render and reload when you save.

For maximum effect, try using Visual Studio Code with the following user settings:

{
  "files.autoSave": "afterDelay",
  "files.autoSaveDelay": 300
}

Just remove the --interactive flag

doctool example

Usage: doctool <inputDir> [<outputDir>] OPTIONS

Arguments       Default    Description
inputDir        -          input files directory
outputDir       .dist      output directory (relative to <inputDir> if applicable)

Options         Default    Description
--interactive   -          runs a web server and automatically re-renders and reloads browsers
--browser       true       open a browser
--wport         39983      web server port
--rport         39984      web-socket page refresh port
--verbose       -          verbose output
--notify        -          send notifications of changes to the OS
--help          -          this screen

See the section below on contributing. It is recommended that you first fork the repo. After that, clone it and enter the repositories directory on the command-line and run

npm install

to install the dependencies.

To stop yourself from going insane, you'll probably want the --no-browser argument when using --interactive to avoid spamming your tab bar.

./src/cli.js --interactive --no-browser example

1. Fork the repository. Committing directly against this repository is highly discouraged.
2. Make your modifications in a branch, updating and writing new tests.
3. Ensure that all tests pass
4. rebase your changes against master. Do not merge.
5. Submit a pull request to this repository. Wait for tests to run and someone to chime in.