@peaceroad/markdown-it-strong-ja 0.3.5 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -2,22 +2,24 @@
2
2
 
3
3
  This is a plugin for markdown-it. It is an alternative to the standard `**` (strong) and `*` (em) processing. It also processes strings that cannot be converted by the standard.
4
4
 
5
- Notice: this is slightly different from the commonmark processing.
6
-
7
5
  ## Use
8
6
 
9
7
  ```js
10
8
  import mdit from 'markdown-it'
11
9
  import mditStrongJa from '@peaceroad/markdown-it-strong-ja'
12
- const md = mdit().use(mditStrongJa)
10
+ import mditAttrs from 'markdown-it-attrs'
11
+ const md = mdit().use(mditStrongJa).use(mditAttrs)
13
12
 
14
13
  md.render('HTMLは**「HyperText Markup Language」**の略です。')
15
14
  // <p>HTMLは<strong>「HyperText Markup Language」</strong>の略です。</p>
16
15
 
16
+
17
17
  md.render('HTMLは*「HyperText Markup Language」*の略です。')
18
18
  // <p>HTMLは<em>「HyperText Markup Language」</em>の略です。</p>
19
19
  ```
20
20
 
21
+ Notice. Basically, it is assumed that you will use markdown-it-attrs in conjunction with this. If you do not use it, please use `use(mditStrongJa, {mditAttrs: false})`.
22
+
21
23
  ## Example
22
24
 
23
25
  The following examples is for strong. The process for em is roughly the same.
@@ -150,4 +152,4 @@ a****b
150
152
  a****
151
153
  [HTML]
152
154
  <p>a****</p>
153
- ~~~
155
+ ~~~