From ec27d980a3ebd4c73c23f9036e5b4edf1dea2e27 Mon Sep 17 00:00:00 2001 From: Mathieu PATUREL Date: Thu, 5 Dec 2019 07:35:27 +1100 Subject: [PATCH] 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... --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1d66386..0b4e9b9 100644 --- a/README.md +++ b/README.md @@ -42,4 +42,24 @@ $ grep -R FIXME 2. Make your own branch (the name of the branch should be the feature you are implementing eg. `improve-tables`, `fix-crash-on-multiple-preview` 3. All your code should be formated by black. -4. Send a PR! \ No newline at end of file +4. Send a PR! + +### Known limitations + +#### Numbered lists are rendered as unordered lists + +```md +1. first +2. second +3. third +``` + +will be previewed the exact same way as + +```md +- first +- second +- third +``` + +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...