Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

mdline Build Status

Markdown timeline format and toolkit.

For example, mdline convert a markdown file to following HTML file.

ecmascript-timeline.png

mdline timeline: https://mdline.netlify.com/
ECMAScript - Wikipedia

Mdline Format

## {{Date}}: TITLE

MARKDOWN BODY

## {{Date}}--{{Date}}: TITLE

MARKDOWN BODY

Example:

## 1997-06: ECMAScript 1

First edition.

## 1998-06: ECMAScript 2

Editorial changes to keep the specification fully aligned with ISO/IEC 16262 international standard.

## 1999-12: ECMAScript 3

Added regular expressions, better string handling, new control statements, try/catch exception handling, tighter definition of errors, formatting for numeric output and other enhancements.

## 2000-01--2007-10-23: [Abandoned] ECMAScript 4

Fourth Edition was abandoned, due to political differences concerning language complexity. Many features proposed for the Fourth Edition have been completely dropped; some were incorporated into the sixth edition.

For more details, see ECMAScript timeline markdown and HTML.

You can also live demo on https://mdline.netlify.com/.

Usage

Install with npm:

npm install --global mdline

Convert mdline format text to html.

mdline ./timeline.md -o timeline.html
# or
npx mdline ./timeline.md -o timeline.html

For more details, see mdline package.

Packages

This repository is a monorepo includes following packages.

Changelog

See Releases page.

Running tests

yarn install
yarn bootrap
yarn test

Release workflow

# = npm version
yarn run versionup
# = npm publish
yarn run release

Docker

You have a basic Docker integration in the docker directory with an example file.

  • Build the image with docker/build.sh. A docker image named mdline will be created.
  • Test the conversion with docker/test.sh. It will convert the docker/example.md file to HTML format.

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