markfound

markfound

Recursively index directories of markdown files for live preview:

• specify one or more base-paths to search
• configure Linux find patterns for include/exclude
• styled for GitHub with option to append your own custom css
• live refresh automatically updates the preview as you edit your markdown, even over nfs, cifs or vboxsf

install globally and run

$ npm install -g markfound            # might need to prefix with sudo

$ cd directory/containing/markdown/files
$ markfound

then navigate to http://localhost:4500 to see the index of markdown files:

Follow a link for a preview which automatically updates as you edit the markdown:

configure

On its first run markfound copies the default configuration file to $XDG_CONFIG_HOME/markfound.conf which defaults to $HOME/.config/markfound.conf. This is a leanconf file with the following settings:

• basePaths: - (required) one or more directory paths to recursively search for markdown files. Place each path on its own line indented to the same level. Specify absolute paths to let markfound be run from anywhere. Default is the current directory only.

• names - (required) a list of one or more wildcard patterns of form *.ext where ext is the extension to include. Place each pattern on its own line indented to the same level.

• excludes - (optional) a list of exclusion patterns passed to the [Linux find] find -path option. Place each path on its own line indented to the same level.

• stylusPath: - (optional) path to a stylus file containing custom styling. For example, to increase the spacing between index list items and add borders around code elements, create a file markfound.styl alongside markfound.conf with this content:

  .index
    li
      margin 1em
  
  .markdown-body
    code
      border solid grey 1px
  

  and add setting stylusPath: ./markfound.styl to markfound.conf.

options

$ markfound --help
Usage: markfound [Options]

Options:

  -h, --help                output usage information
  -V, --version             output the version number
  -c, --config-path [path]  path to configuration file (default:~/.config/markfound.conf)
  -p, --port [port]         listening port (default:4500)
  -v, --verbose             emit detailed trace for debugging

developer build and run

$ git clone --branch=dev https://github.com/dizzib/markfound.git
$ cd markfound
$ npm install     # install dependencies
$ npm test        # build all and run tests
$ npm start       # start the task runner

license

MIT