From fbdcf4a595934674130dd4c0f722d7329d1f54ce Mon Sep 17 00:00:00 2001 From: Vitaly Puzrin Date: Sun, 26 Oct 2014 20:18:41 +0300 Subject: [PATCH] grammar/typo fixes (manually imported from #65) --- README.md | 14 +++++++------- demo/assets/index.js | 6 +++--- demo/sample.js | 6 +++--- lib/configs/commonmark.js | 8 ++++---- lib/configs/default.js | 8 ++++---- lib/configs/full.js | 8 ++++---- 6 files changed, 25 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index e255b01..b5f4086 100644 --- a/README.md +++ b/README.md @@ -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 (
) breaks: false, // Convert '\n' in paragraphs into
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 diff --git a/demo/assets/index.js b/demo/assets/index.js index d991cce..5656ef3 100644 --- a/demo/assets/index.js +++ b/demo/assets/index.js @@ -4,12 +4,12 @@ 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 (
) breaks: false, // Convert '\n' in paragraphs into
langPrefix: 'language-', // CSS language prefix for fenced blocks - linkify: true, // autoconvert url-like texts to links - typographer: true, // Enable smartypants and other sweet transforms + linkify: true, // autoconvert URL-like texts to links + typographer: true, // Enable smartypants and other sweet transforms // options below are for demo only _highlight: true, diff --git a/demo/sample.js b/demo/sample.js index 981e1c5..14a735f 100644 --- a/demo/sample.js +++ b/demo/sample.js @@ -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 (
) breaks: false, // Convert '\n' in paragraphs into
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)) { diff --git a/lib/configs/commonmark.js b/lib/configs/commonmark.js index 2184cb6..a7eb551 100644 --- a/lib/configs/commonmark.js +++ b/lib/configs/commonmark.js @@ -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 (
) breaks: false, // Convert '\n' in paragraphs into
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) → ® diff --git a/lib/configs/default.js b/lib/configs/default.js index 884c072..f67aa81 100644 --- a/lib/configs/default.js +++ b/lib/configs/default.js @@ -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 (
) breaks: false, // Convert '\n' in paragraphs into
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) → ® diff --git a/lib/configs/full.js b/lib/configs/full.js index c7a59cd..d29d6c4 100644 --- a/lib/configs/full.js +++ b/lib/configs/full.js @@ -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 (
) breaks: false, // Convert '\n' in paragraphs into
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) → ®