blob: 709e07c78954d0f0a0ca825b7ac14d097df8cbd7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
# remark-line-input
A [remark](https://github.com/remarkjs/remark/) plugin that parse markdown syntax to add support for line input.
This plugin is intend to be used with Javascript to create interaction.
## Syntax
You can add a line input this way :
```markdown
[___Placeholder___]
```
Which leads to :
A markdown line input starts by `[__` and ends by `__]`.
```markdown
[___hold my beer___]
```
That syntax is not valid :
```markdown
[___ Spaces_are_not_allowed ___]
^ ^^
[___Nor line feeds
____]
```
## Installation
Easy as [npm][npm] i
```shell
$ npm install remark-line-input
```
## Dependencies:
```javascript
const unified = require('unified')
const remarkParse = require('remark-parse')
const stringify = require('rehype-stringify')
const remark2rehype = require('remark-rehype')
const lineInput = require('remark-line-input')
```
## Usage
An example of code :
```javascript
const testFile = `Login : [__email or username__]{#login}
Passwd: [__Passwd__]{#password type=password}`
unified()
.use(remarkParse)
.use(lineInput)
.use(remark2rehype)
.use(stringify)
.process( testFile, (err, file) => {
console.log(String(file));
} );
```
## Configuration
This plugin support custom HTML attributes thought [md-attr-parser][attr] :
```markdown
[___Password___]{type=password}
```
Or :
```markdown
[___Email___]{.form-elem onchange='check();' #login}
```
## Licence
Distributed under a MIT-like license.
[attr]: "https://github.com/arobase-che/md-attr-parser"
[npm]: "https://www.npmjs.com/package/remark-line-input"
|
