Skip to content
This repository has been archived by the owner on Dec 1, 2022. It is now read-only.

Improve Markdown renderer in DocViewer #171

Closed
jviotti opened this issue Jul 8, 2019 · 4 comments
Closed

Improve Markdown renderer in DocViewer #171

jviotti opened this issue Jul 8, 2019 · 4 comments
Assignees

Comments

@jviotti
Copy link

jviotti commented Jul 8, 2019

Seems like it can't handle things such as:

  • A language after the triple back ticks
  • Back ticks in titles
  • Markdown tables
  • Images

We have the data correctly represented as JSONML, so we probably just need a better JSONML to markdown (or HTML) module.

Some examples:

Screenshot 2019-07-08 at 18 46 16

Screenshot 2019-07-08 at 18 46 08

@dimitrisnl
Copy link
Contributor

Seems like this is a limitation by the library evilstreak/markdown-js#41

They don't support this syntax, and the project is un unmaintained.

Needs to find a working alternative that hopefully has some jsonml helpers too.

@dimitrisnl
Copy link
Contributor

@jviotti Can you remind me how to generate/update meta.json?

The jsonML object has parsed the table as a string

              [
                "para",
                "| Arguments | Description | Optional? | Default |\n|-----------|-------------|-----------|---------|\n| ",
                [
                  "inlinecode",
                  "[meta.json]"
                ],
                " | Path to ",
                [
                  "inlinecode",
                  "meta.json"
                ],
                " | Y | ",
                [
                  "inlinecode",
                  "$PWD/meta.json"
                ],
                " |"
              ],

@jviotti
Copy link
Author

jviotti commented Jul 10, 2019

@dimitrisnl
Copy link
Contributor

Should be addressed by this PR #264

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants