-
Notifications
You must be signed in to change notification settings - Fork 21
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
Pandoc Markdown Writers #302
Conversation
Thanks for this heroic PR! The new Note that |
e179fb9
to
ac2a1bb
Compare
Thanks for working on this--let me know if there's anything I can do to help with the plotnine docs (linking below so I can find easily). Happy to help! Once the plotnine docs are deployed, I'm happy to work on refactoring the renderer back into quartodoc. I think it might be a bit tricky because it inherits the base renderer (vs this commit, which used MdRenderer), but I don't mind spending time refactoring the common parts back into the base Renderer. This numpydoc renderer is a super great addition! |
2e1848e
to
17f811b
Compare
@has2k1 I'm on board with merging in the pandoc work, and then a separate PR for the renderer, if that's useful. (We can also modify the pandoc work in the later PR as needed). WDYT? If you're able to add tests for the pandoc module (say in |
I will do that. |
17f811b
to
2d02ced
Compare
2d02ced
to
fc30dfc
Compare
Now, this PR only adds the pandoc sub-package plus tests. |
This reduces the cases were Inlines is needed.
This reduces the cases were Blocks is needed.
This looks great--thanks for taking the time to add this, and for all the tests! |
Ref: #247
In trying to get this nice and well done it has become bigger than I envisioned but I think it will be worth it.
The main source of the "scope creep" has been need to come up with a systematic way of generating markdown for pandoc elements. The benefits are Renderers do less funky string manipulations and that uniform markup is generated. This is the reason for the pandoc sub-package modelled after module-pandoc that underpins the lua-filters and the pandoc types.
Relate to the above, I have noticed some kind of duplication/conflict in the interlinks module. I have not looked into it, but in the end this should be harmonised.
In trying to ensure that we create valid markdown markup, we should rethink the use of backticks for intermediate links created for the interlink filter. i.e.
[title](`target`)
. As backticks are markup for code snippets, using them for a second purpose means that we create markup that may be confusing. An alternative is[title](:target:)
.This gist has code that you may use to test out this PR.