Vitaly Puzrin
5 years ago
committed by
GitHub
4 changed files with 98 additions and 0 deletions
@ -0,0 +1,28 @@ |
|||
--- |
|||
name: Bug report |
|||
about: Create a report to help us improve |
|||
title: '' |
|||
labels: '' |
|||
assignees: '' |
|||
|
|||
--- |
|||
|
|||
<!-- |
|||
|
|||
Please note, this package is about IMPLEMENTATION of CommonMark https://commonmark.org/, not about markdown itself. We stay aside of markup discussions. Prior to report a bug, make sure it's about this package, not generic thing. |
|||
|
|||
**Before you post** |
|||
|
|||
1. https://spec.commonmark.org/ - make sure you've read CommonMark spec. |
|||
2. https://spec.commonmark.org/dingus/ - if you think you found parse error, check it in reference implementation first. |
|||
|
|||
**In your report** |
|||
|
|||
It will be very helpful, if you can provide permalinks with online samples and explain the difference: |
|||
|
|||
- https://markdown-it.github.io/ - online demo of `markdown-it`. |
|||
- https://spec.commonmark.org/dingus/ - online demo of reference CommonMark's implementation. |
|||
|
|||
If you wish to provide code sample - make sure it is as small as possible and can be executed. |
|||
|
|||
--> |
@ -0,0 +1,25 @@ |
|||
--- |
|||
name: Development question |
|||
about: '' |
|||
title: '' |
|||
labels: '' |
|||
assignees: '' |
|||
|
|||
--- |
|||
|
|||
<!-- |
|||
|
|||
Note, we have some time constrains, but we always try to help developers, who write plugins. So: |
|||
|
|||
- Please, avoid generic programming questions. |
|||
- Avoid questions about markdown. Use CommonMark resources for that https://commonmark.org/. |
|||
- If you have issue with plugin - report it to plugin's repo/author. |
|||
- Make sure you are familiar with dev docs https://github.com/markdown-it/markdown-it/tree/master/docs, and tried to do something. |
|||
- Code samples are welcome. |
|||
|
|||
Also, you may find useful this links (may be someone already solved your problem): |
|||
|
|||
- https://github.com/markdown-it - list of "officially" provided plugins. |
|||
- https://www.npmjs.com/search?q=keywords:markdown-it-plugin - community-written plugins. |
|||
|
|||
--> |
@ -0,0 +1,20 @@ |
|||
--- |
|||
name: Feature request |
|||
about: Suggest an idea for this project |
|||
title: '' |
|||
labels: '' |
|||
assignees: '' |
|||
|
|||
--- |
|||
|
|||
<!-- |
|||
|
|||
Please note, this package is highly extendable. Prior to request new feature, make sure it can not be implemented via plugins. |
|||
|
|||
You may also find useful this links: |
|||
|
|||
- https://github.com/markdown-it - list of "officially" provided plugins. |
|||
- https://www.npmjs.com/search?q=keywords:markdown-it-plugin - community-written plugins. |
|||
- https://github.com/markdown-it/markdown-it/tree/master/docs - docs for plugin developers. |
|||
|
|||
--> |
@ -0,0 +1,25 @@ |
|||
--- |
|||
name: Question |
|||
about: For developpers |
|||
title: '' |
|||
labels: '' |
|||
assignees: '' |
|||
|
|||
--- |
|||
|
|||
<!-- |
|||
|
|||
Note, we have some time constrains, but we always try to help developers, who write plugins. So: |
|||
|
|||
- Please, avoid generic programming questions. |
|||
- Avoid questions about markdown. Use CommonMark resources for that https://commonmark.org/. |
|||
- If you have issue with plugin - report it to plugin's repo/author. |
|||
- Make sure you are familiar with dev docs https://github.com/markdown-it/markdown-it/tree/master/docs, and tried to do something. |
|||
- Code samples are welcome. |
|||
|
|||
Also, you may find useful this links (may be someone already solved your problem): |
|||
|
|||
- https://github.com/markdown-it - list of "officially" provided plugins. |
|||
- https://www.npmjs.com/search?q=keywords:markdown-it-plugin - community-written plugins. |
|||
|
|||
--> |
Loading…
Reference in new issue