Public-Mirrors
/
markdown-it
mirror of https://github.com/markdown-it/markdown-it.git
1
0
Fork 0
Code Issues Releases Activity
Browse Source

grammar/typo fixes (manually imported from #65)

pull/14/head
Vitaly Puzrin 10 years ago
parent
54990dd7c5
commit
fbdcf4a595
6 changed files with 25 additions and 25 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 14
      README.md
  2. 4
      demo/assets/index.js
  3. 6
      demo/sample.js
  4. 8
      lib/configs/commonmark.js
  5. 8
      lib/configs/default.js
  6. 8
      lib/configs/full.js

14
README.md
View File

@ -38,14 +38,14 @@ var Remarkable = require('remarkable');
// This values are default
var md = new Remarkable(/* "default" */, {
html: false, // Enable html tags in source
html: false, // Enable HTML tags in source
xhtmlOut: false, // Use '/' to close single tags (<br />)
breaks: false, // Convert '\n' in paragraphs into <br>
langPrefix: 'language-', // CSS language prefix for fenced blocks
linkify: false, // Autoconvert url-like texts to links
linkify: false, // Autoconvert URL-like texts to links
typographer: false, // Enable smartypants and other sweet transforms
// Highlighter function. Should return escaped html,
// Highlighter function. Should return escaped HTML,
// or '' if input not changed
highlight: function (/*str, , lang*/) { return ''; }
});
@ -66,7 +66,7 @@ md.set({
});
```
__Note.__ To acheive best performance, don't modify the `Remarkable` instance on
__Note.__ To achieve best performance, don't modify the `Remarkable` instance on
the fly. If you need several configurations - create multiple instances and
initialise each appropriately.
@ -144,7 +144,7 @@ md = new Remarkable('full', {
### Typographer
Though full-weight typograpic replacements are language specific, `remarkable`
Though full-weight typographic replacements are language specific, `remarkable`
provides the most common and universal case coverage:
```js
@ -154,7 +154,7 @@ var md = new Remarkable({ typographer: true });
// These values are default
md.typographer.set({
singleQuotes: '‘’', // set empty to disable
doubleQuotes: '“”', // set '«»' for russian, '„“' for deutch, empty to disable
doubleQuotes: '“”', // set '«»' for Russian, '„“' for German, empty to disable
copyright: true, // (c) (C) → ©
trademark: true, // (tm) (TM) → ™
registered: true, // (r) (R) → ®
@ -181,7 +181,7 @@ Links:
1. https://github.com/jgm/CommonMark - reference CommonMark implementations in C & JS,
also contains latest spec & online demo.
2. http://talk.commonmark.org - CommonMark forum, good place to collaborate
developpers efforts.
developers' efforts.
## Development / Modification

4
demo/assets/index.js
View File

@ -4,11 +4,11 @@
var mdHtml, mdSrc, permalink;
var defaults = {
html: false, // Enable html tags in source
html: false, // Enable HTML tags in source
xhtmlOut: false, // Use '/' to close single tags (<br />)
breaks: false, // Convert '\n' in paragraphs into <br>
langPrefix: 'language-', // CSS language prefix for fenced blocks
linkify: true, // autoconvert url-like texts to links
linkify: true, // autoconvert URL-like texts to links
typographer: true, // Enable smartypants and other sweet transforms
// options below are for demo only

6
demo/sample.js
View File

@ -2,14 +2,14 @@ var Remarkable = require('remarkable');
var hljs = require('highlight.js') // https://highlightjs.org/
var md = new Remarkable('full', {
html: false, // Enable html tags in source
html: false, // Enable HTML tags in source
xhtmlOut: false, // Use '/' to close single tags (<br />)
breaks: false, // Convert '\n' in paragraphs into <br>
langPrefix: 'language-', // CSS language prefix for fenced blocks
linkify: true, // autoconvert url-like texts to links
linkify: true, // autoconvert URL-like texts to links
typographer: true, // Enable smartypants and other sweet transforms
// Highlighter function. Should return escaped html,
// Highlighter function. Should return escaped HTML,
// or '' if input not changed
highlight: function (str, lang) {
if (lang && hljs.getLanguage(lang)) {

8
lib/configs/commonmark.js
View File

@ -5,14 +5,14 @@
module.exports = {
options: {
html: true, // Enable html tags in source
html: true, // Enable HTML tags in source
xhtmlOut: true, // Use '/' to close single tags (<br />)
breaks: false, // Convert '\n' in paragraphs into <br>
langPrefix: 'language-', // CSS language prefix for fenced blocks
linkify: false, // autoconvert url-like texts to links
linkify: false, // autoconvert URL-like texts to links
typographer: false, // Enable smartypants and other sweet transforms
// Highlighter function. Should return escaped html,
// Highlighter function. Should return escaped HTML,
// or '' if input not changed
highlight: function (/*str, , lang*/) { return ''; },
@ -52,7 +52,7 @@ module.exports = {
typographer: {
options: {
singleQuotes: '‘’', // set empty to disable
doubleQuotes: '“”', // set '«»' for russian, '„“' for deutch, empty to disable
doubleQuotes: '“”', // set '«»' for Russian, '„“' for German, empty to disable
copyright: true, // (c) (C) → ©
trademark: true, // (tm) (TM) → ™
registered: true, // (r) (R) → ®

8
lib/configs/default.js
View File

@ -5,14 +5,14 @@
module.exports = {
options: {
html: false, // Enable html tags in source
html: false, // Enable HTML tags in source
xhtmlOut: false, // Use '/' to close single tags (<br />)
breaks: false, // Convert '\n' in paragraphs into <br>
langPrefix: 'language-', // CSS language prefix for fenced blocks
linkify: false, // autoconvert url-like texts to links
linkify: false, // autoconvert URL-like texts to links
typographer: false, // Enable smartypants and other sweet transforms
// Highlighter function. Should return escaped html,
// Highlighter function. Should return escaped HTML,
// or '' if input not changed
highlight: function (/*str, , lang*/) { return ''; },
@ -54,7 +54,7 @@ module.exports = {
typographer: {
options: {
singleQuotes: '‘’', // set empty to disable
doubleQuotes: '“”', // set '«»' for russian, '„“' for deutch, empty to disable
doubleQuotes: '“”', // set '«»' for Russian, '„“' for German, empty to disable
copyright: true, // (c) (C) → ©
trademark: true, // (tm) (TM) → ™
registered: true, // (r) (R) → ®

8
lib/configs/full.js
View File

@ -5,14 +5,14 @@
module.exports = {
options: {
html: false, // Enable html tags in source
html: false, // Enable HTML tags in source
xhtmlOut: false, // Use '/' to close single tags (<br />)
breaks: false, // Convert '\n' in paragraphs into <br>
langPrefix: 'language-', // CSS language prefix for fenced blocks
linkify: false, // autoconvert url-like texts to links
linkify: false, // autoconvert URL-like texts to links
typographer: false, // Enable smartypants and other sweet transforms
// Highlighter function. Should return escaped html,
// Highlighter function. Should return escaped HTML,
// or '' if input not changed
highlight: function (/*str, , lang*/) { return ''; },
@ -28,7 +28,7 @@ module.exports = {
typographer: {
options: {
singleQuotes: '‘’', // set empty to disable
doubleQuotes: '“”', // set '«»' for russian, '„“' for deutch, empty to disable
doubleQuotes: '“”', // set '«»' for Russian, '„“' for German, empty to disable
copyright: true, // (c) (C) → ©
trademark: true, // (tm) (TM) → ™
registered: true, // (r) (R) → ®

Write Preview
Loading…
Cancel
Save