diff options
author | ache <ache@ache.one> | 2018-02-12 03:34:01 +0100 |
---|---|---|
committer | ache <ache@ache.one> | 2018-02-12 03:34:01 +0100 |
commit | 683517d16fa20b62e609372e322bf85465ca391f (patch) | |
tree | f77d8b34fdcc84e4f3f98d0d285a73779ea5af08 | |
parent | Add new tests (diff) |
Add a README
-rw-r--r-- | README.md | 42 | ||||
-rw-r--r-- | images/example_1.png | bin | 0 -> 1073 bytes | |||
-rw-r--r-- | images/example_2.png | bin | 0 -> 1081 bytes | |||
-rw-r--r-- | images/example_3.png | bin | 0 -> 687 bytes |
4 files changed, 42 insertions, 0 deletions
@@ -1,3 +1,45 @@ # remark-line-input +A [remark](https://github.com/remarkjs/remark/) plugin that parse Mardown syntax to add support for line input. + + +## Syntax + +You can add a line input this way : + +```markdown +[___Placeholder___] +``` + +Wich leads to : + +![Screenshot](https://raw.githubusercontent.com/arobase-che/remark-line-input/master/images/example_1.png) + + +## Installation + +Not ready at the moment. + + +## Configuration + +This plugin support custom HTML attributes : + +```markdown +[___Password___]{type=password} +``` + +![Screenshot](https://raw.githubusercontent.com/arobase-che/remark-line-input/master/images/example_2.png) + +![Screenshot](https://raw.githubusercontent.com/arobase-che/remark-line-input/master/images/example_3.png) + +Or : + +```markdown +[___Email___]{.form-elem onchange='check();' #login} +``` + +## Licence + +MIT diff --git a/images/example_1.png b/images/example_1.png Binary files differnew file mode 100644 index 0000000..f089895 --- /dev/null +++ b/images/example_1.png diff --git a/images/example_2.png b/images/example_2.png Binary files differnew file mode 100644 index 0000000..6f0a391 --- /dev/null +++ b/images/example_2.png diff --git a/images/example_3.png b/images/example_3.png Binary files differnew file mode 100644 index 0000000..136f753 --- /dev/null +++ b/images/example_3.png |