Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Try out Markdown #5

Open
1 of 2 tasks
barmac opened this issue Jul 18, 2023 · 8 comments
Open
1 of 2 tasks

Try out Markdown #5

barmac opened this issue Jul 18, 2023 · 8 comments
Assignees

Comments

@barmac
Copy link
Contributor

barmac commented Jul 18, 2023

  • Convert DMN Word to Markdown with pandoc
  • Explore from there
@barmac barmac self-assigned this Jul 18, 2023
@barmac
Copy link
Contributor Author

barmac commented Jul 19, 2023

@falko
Copy link
Contributor

falko commented Jul 19, 2023

Native IDE support shows the popularity of Markdown: https://code.visualstudio.com/docs/languages/markdown

@falko
Copy link
Contributor

falko commented Jul 19, 2023

According to https://github.blog/2017-03-14-a-formal-spec-for-github-markdown/ GitHub uses https://github.com/vmg/sundown as a library.

@barmac
Copy link
Contributor Author

barmac commented Jul 19, 2023

GitHub Flavored Markdown is specified at https://github.github.com/gfm/

@barmac
Copy link
Contributor Author

barmac commented Jul 19, 2023

If we want to render HTML from GFM, the tool for that is https://github.com/github/cmark-gfm

@barmac
Copy link
Contributor Author

barmac commented Jul 19, 2023

The diff between documents can be rendered with git diff --word-diff

@falko
Copy link
Contributor

falko commented Jul 20, 2023

The diff between documents can be rendered with git diff --word-diff

I'm not sure, I'll call that "rendered" but it could be a workaround. Also I tried it with the AsciiDoc PR #4 and got mixed results.

@barmac
Copy link
Contributor Author

barmac commented Jul 24, 2023

Features we may need which are not supported out of the box:

  • table of contents
  • links to non-headings (e.g. figures) -> this can be done via custom html, e.g. <span id=figure>figure</span>

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

No branches or pull requests

2 participants