Browse Source

Docs & demo link update

pull/14/head
Vitaly Puzrin 10 years ago
parent
commit
ca453bd017
  1. 109
      CHANGELOG.md
  2. 28
      README.md

109
CHANGELOG.md

@ -4,112 +4,3 @@
- New project name & home! Now it's `markdown-it`,
- Sugar for constructor call - `new` is not mandatory now.
- Renamed presets folder (configs -> presets).
1.5.0 / 2014-12-12
------------------
- Added Demo sync scroll, to show how lines mapping can be used.
- Improved IE8 support. Now you need only es5-shim, without es5-sham.
- Fixed errors on refs/attrs/footnoted with special names like `__proto__`.
- Renamed Ruler() private properties, to show those should not be accessed
directly.
- Fixed Makefile OSX compatibility.
1.4.2 / 2014-11-29
------------------
- Added footnotes support.
- Added definitions lists support.
- Added `fence_custom` renderer extension to easy override
named fenced blocks (useful for diagrams and so on).
- Exposed `./common/utils` to simplify custom renderers.
1.4.1 / 2014-11-13
------------------
- Moved links decode/encode from renderer to parser.
- Added missed validator call for scoped urls in links.
- Handle exceptions in `decoreURI` (regression).
1.4.0 / 2014-11-09
------------------
- Added `core` chain, to better organize code and improve pluggability.
- Added `renderInline()` and `parseInline()` methods.
- Added abbreviations support.
- Fixed problem with tables, having single column.
- Fixed rendered rules rewrite for inline tags.
- Changed internal api (ruler, inline, block classes).
- Removed typographer chain (rules moved to `core`).
- Removed all typographer options. Quote chars defs moved to `options.quotes`.
1.3.0 / 2014-10-29
------------------
- Fixed problem with minified & mangled browser version.
- Changed ruler API.
1.2.2 / 2014-10-29
------------------
- Fixed regression from 1.2.1 for data without tailing `\n`.
- Fixed blockquote line ranges.
- Added subscript/superscript support.
- Updated CommonMark spec and updated implementation.
- Other minor changes.
1.2.1 / 2014-10-28
------------------
- Fixed speed degradation when linkifier enabled.
- Added coverage reports.
- Added debug view to demo (show internal representation)
- Other minor optimizations and cleanup.
1.2.0 / 2014-10-26
------------------
- Added `<ins>` rule.
- Added `<mark>` rule.
- Added presets support (default, commonmark, full).
- Exposed `.configure()` method to load rules & options config with one command.
- Moved html escaping to renderer.
1.1.2 / 2014-10-23
------------------
- Fixed speed regression.
- Use base64 encoding for permalinks (workaround for github).
- Improved default link validator.
- Updated cache storage logic for inline parser.
1.1.1 / 2014-10-22
------------------
- Fixed `Ruler.after()` method.
- Fixed linkification.
- Simplified loose/tight rendering.
- Refactored inline parser. No close coupled code in rules anymore.
1.1.0 / 2014-10-20
------------------
- Code refactoring, bugfixes, API update.
- Added source lines info to block nodes.
1.0.0 / 2014-10-16
------------------
- First release.

28
README.md

@ -1,12 +1,12 @@
# markdown-it
[![Build Status](https://travis-ci.org/markdown-it/markdown-it.svg?branch=master)](https://travis-ci.org/markdown-it/markdown-it)
[![Build Status](https://img.shields.io/travis/markdown-it/markdown-it/master.svg?style=flat)](https://travis-ci.org/markdown-it/markdown-it)
[![NPM version](https://img.shields.io/npm/v/markdown-it.svg?style=flat)](https://www.npmjs.org/package/markdown-it)
[![Coverage Status](https://img.shields.io/coveralls/markdown-it/markdown-it/master.svg?style=flat)](https://coveralls.io/r/markdown-it/markdown-it?branch=dev)
> Markdown parser done right. Fast and easy to extend.
__[Live demo](http://markdown-it.github.io/markdown-it/demo/)__
__[Live demo](https://markdown-it.github.io)__
- Supports the [CommonMark](http://commonmark.org/) spec +
[syntax extensions](#syntax-extensions) + sugar (URL autolinking, typographer).
@ -32,21 +32,19 @@ bower install markdown-it --save
## Usage
```js
// Sugar notation
var md = require('markdown-it')();
// Or honestly as class:
//
// var MarkdownIt = require('markdown-it');
// var md = new MarkdownIt();
// node.js, standard way:
var MarkdownIt = require('markdown-it'),
md = new MarkdownIt();
console.log(md.render('# markdown-it rulezz!'));
// => <h1>markdown-it rulezz!</h1>
```
In browser, when loaded global (without require.js):
// node.js, the same, but with sugar:
var md = require('markdown-it')();
console.log(md.render('# markdown-it rulezz!'));
```js
// browser without AMD, added to "window" on script load
// Note, there are no dash.
var md = window.markdownit();
console.log(md.render('# markdown-it rulezz!'));
```
@ -57,7 +55,9 @@ This is easy to change if you prefer to use different settings.
There are two ways to define options.
#### constructor
#### constructor(preset, options)
- __preset__ (String): "full"|"commonmark"|Optional.
Define options in the constructor:

Loading…
Cancel
Save