Skip to content

Commit cfdd5dc

Browse files
committed
Copy from markdown-it fork
chrisjsewell/markdown-it@608764a `js2py` branch
1 parent 75ed8b7 commit cfdd5dc

File tree

215 files changed

+56333
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

215 files changed

+56333
-0
lines changed

.flake8

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[flake8]
2+
max-line-length = 100
3+
ignore = E203,W503
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
12+
Please note, this package is about IMPLEMENTATION of CommonMark https://commonmark.org/, and adherence to he upstream markdown-it package,
13+
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.
14+
15+
**Before you post**
16+
17+
1. https://spec.commonmark.org/ - make sure you've read CommonMark spec.
18+
2. https://spec.commonmark.org/dingus/ - if you think you found parse error, check it in reference implementation first.
19+
3. https://markdown-it.github.io/ to test what is the expected output from markdown-ot
20+
21+
**In your report**
22+
23+
It will be very helpful, if you can provide permalinks with online samples and explain the difference:
24+
25+
- https://markdown-it.github.io/ - online demo of `markdown-it`.
26+
- https://spec.commonmark.org/dingus/ - online demo of reference CommonMark's implementation.
27+
28+
If you wish to provide code sample - make sure it is as small as possible and can be executed.
29+
30+
-->
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
12+
Please note, this package is highly extendable. Prior to request new feature, make sure it can not be implemented via plugins.
13+
14+
You may also find useful this links:
15+
16+
- https://github.com/markdown-it - list of "officially" provided plugins.
17+
- https://www.npmjs.com/search?q=keywords:markdown-it-plugin - community-written plugins.
18+
- https://github.com/markdown-it/markdown-it/tree/master/docs - docs for plugin developers.
19+
20+
-->

.github/ISSUE_TEMPLATE/question.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Question
3+
about: For developpers
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
12+
Note, we have some time constrains, but we always try to help developers, who write plugins. So:
13+
14+
- Please, avoid generic programming questions.
15+
- Avoid questions about markdown. Use CommonMark resources for that https://commonmark.org/.
16+
- If you have issue with plugin - report it to plugin's repo/author.
17+
- Make sure you are familiar with dev docs https://github.com/markdown-it/markdown-it/tree/master/docs, and tried to do something.
18+
- Code samples are welcome.
19+
20+
Also, you may find useful this links (may be someone already solved your problem):
21+
22+
- https://github.com/markdown-it - list of "officially" provided plugins.
23+
- https://www.npmjs.com/search?q=keywords:markdown-it-plugin - community-written plugins.
24+
25+
-->

.gitignore

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,3 +127,13 @@ dmypy.json
127127

128128
# Pyre type checker
129129
.pyre/
130+
131+
benchmark/extra/
132+
node_modules/
133+
coverage/
134+
demo/
135+
apidoc/
136+
*.log
137+
__pycache__/
138+
.ropeproject/
139+
*.egg-info/

.pre-commit-config.yaml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Install pre-commit hooks via
2+
# pre-commit install
3+
4+
exclude: >
5+
(?x)^(
6+
\.vscode/settings\.json|
7+
test.*\.md|
8+
test.*\.txt|
9+
test.*\.html|
10+
.*commonmark\.json|
11+
benchmark/.*\.md|
12+
markdown\_it/cli/spec\.md
13+
)$
14+
15+
repos:
16+
17+
- repo: git://github.com/pre-commit/pre-commit-hooks
18+
rev: v2.2.3
19+
hooks:
20+
- id: check-json
21+
- id: check-yaml
22+
- id: end-of-file-fixer
23+
- id: trailing-whitespace
24+
- id: flake8
25+
26+
- repo: https://github.com/psf/black
27+
rev: stable
28+
hooks:
29+
- id: black

.vscode/settings.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"editor.rulers": [88],
3+
"files.exclude": {
4+
"**/.git": true,
5+
"**/.svn": true,
6+
"**/.hg": true,
7+
"**/CVS": true,
8+
"**/.DS_Store": true,
9+
"**/__pycache__": true
10+
},
11+
"python.formatting.provider": "black",
12+
"python.pythonPath": "/anaconda/envs/js2py/bin/python",
13+
"python.linting.pylintEnabled": false,
14+
"python.linting.flake8Enabled": true,
15+
"python.linting.enabled": true,
16+
"autoDocstring.customTemplatePath": "docstring.fmt.mustache"
17+
}

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
### If you commit changes:
2+
3+
1. Make sure all tests pass.
4+
2. Run `mardown-it-bench`, make sure that performance not degraded.
5+
6+
### Other things:
7+
8+
1. Prefer [gitter](https://gitter.im/markdown-it/markdown-it) for short "questions".
9+
Keep issues for bug reports, suggestions and so on.
10+
2. Make sure to read [dev info](https://github.com/markdown-it/markdown-it/tree/master/docs)
11+
prior to ask about plugins development.
12+
3. __Provide examples with [demo](https://markdown-it.github.io/) when possible.__

MANIFEST.in

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
include LICENSE
2+
include markdown_it/cli/spec.md

0 commit comments

Comments
 (0)