Skip to content

Commit ec27d98

Browse files
authored
meta: add known limitation about ordered lists #97
Sublime Text renders ordered lists as unordered lists. I've only added it to the README.md for now, because I'm not sure about how the GitHub website and README should sync...
1 parent 9fe7369 commit ec27d98

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,24 @@ $ grep -R FIXME
4242
2. Make your own branch (the name of the branch should be the feature you are
4343
implementing eg. `improve-tables`, `fix-crash-on-multiple-preview`
4444
3. All your code should be formated by black.
45-
4. Send a PR!
45+
4. Send a PR!
46+
47+
### Known limitations
48+
49+
#### Numbered lists are rendered as unordered lists
50+
51+
```md
52+
1. first
53+
2. second
54+
3. third
55+
```
56+
57+
will be previewed the exact same way as
58+
59+
```md
60+
- first
61+
- second
62+
- third
63+
```
64+
65+
The issue comes from [Sublime Text's minihtml](https://www.sublimetext.com/docs/3/minihtml.html) which [doesn't support ordered lists](https://github.com/sublimehq/sublime_text/issues/1767). If you think feel like implementing a workaround, feel free to contribute, but it's not something I'm planning on doing. It isn't a critical feature, and support should come with time...

0 commit comments

Comments
 (0)