Browse Source

[docs] fixed some small errors (#531)

pull/538/head
0xflotus 5 years ago
committed by Vitaly Puzrin
parent
commit
bda94b0521
  1. 4
      docs/architecture.md
  2. 2
      docs/development.md
  3. 2
      docs/security.md

4
docs/architecture.md

@ -89,7 +89,7 @@ can investigate existing rules & plugins to see possible approaches.
Also, in complex cases you can try to ask for help in tracker. Condition is very
simple - it should be clear from your ticket, that you studied docs, sources,
and tried to do something yourself. We never reject with help to real developpers.
and tried to do something yourself. We never reject with help to real developers.
## Renderer
@ -137,7 +137,7 @@ md.renderer.rules.image = function (tokens, idx, options, env, self) {
Here is another example, how to add `target="_blank"` to all links:
```js
// Remember old renderer, if overriden, or proxy to default renderer
// Remember old renderer, if overridden, or proxy to default renderer
var defaultRender = md.renderer.rules.link_open || function(tokens, idx, options, env, self) {
return self.renderToken(tokens, idx, options);
};

2
docs/development.md

@ -38,7 +38,7 @@ Before continuing, make sure you've read:
To simplify search:
- add to `package.json` keyswords `markdown-it` and `markdown-it-plugin` for plugins.
- add to `package.json` keywords `markdown-it` and `markdown-it-plugin` for plugins.
- add keyword `markdown-it` for any other related packages.

2
docs/security.md

@ -2,7 +2,7 @@
Many people don't understand that markdown format does not care much about
security. In many cases you have to pass output to sanitizers. `markdown-it`
provides 2 possible stategies to produce safe output:
provides 2 possible strategies to produce safe output:
1. Don't enable HTML. Extend markup features with [plugins](https://www.npmjs.org/browse/keyword/markdown-it-plugin). We think it's the best choice and use it by default.
- That's ok for 99% of user needs.

Loading…
Cancel
Save