Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
bin
src
test
CHANGELOG.md
LICENSE
README.md
package.json
tsconfig.json

README.md

mdline

markdown to timeline tool.

Install

Install with npm:

npm install mdline

Usage: CLI

Usage
  $ mdline <input> [Options]

Options
  --output, -o  Output path

Examples
  $ mdline ./timeline.md -o timeline.html

Usage: Module

import { processText } from "mdline";
import * as parser from "@mdline/mdline-parser";
import * as formatter from "@mdline/mdline-formatter-html";
processText("...", {
    parser,
    formatter
})
.then(result => {
    console.log(result);    
});

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu