You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Write or improve documentation. If you ran into a problem which took more time to figure out than expected, please consider to save other users from the same experience. People writing the documentation tend to lack an outside view, so please help provide one. Good documentation is both difficult and extremely important.
Describe your proposed improvement and the problem it solves.
In the Lua Filters documentation, there are generally 2 different sections for the various types, and their constructors. eg.
While I was recently exploring writing a lua filter I found myself spending a lot of time jumping back and forth in the docs, and felt like it would be easier if those sections cross-linked to one another.
Describe alternatives you've considered.
I'm aware of this issue/PR, but the nuance is different:
In the spirit of:
Describe your proposed improvement and the problem it solves.
In the Lua Filters documentation, there are generally 2 different sections for the various types, and their constructors. eg.
Emph
(type)`: https://pandoc.org/lua-filters.html#type-emphEmph
(contructor): https://pandoc.org/lua-filters.html#pandoc.EmphCodeBlock
(type): https://pandoc.org/lua-filters.html#type-codeblockCodeBlock
(constructor): https://pandoc.org/lua-filters.html#pandoc.CodeBlockA pattern I've noticed is that the 'type' usually includes a cross-link to the 'constructor':
But the 'constructor' doesn't seem to include a crosslink to the 'type', and usually only refers to the more generic
Block
/Inline
:While I was recently exploring writing a lua filter I found myself spending a lot of time jumping back and forth in the docs, and felt like it would be easier if those sections cross-linked to one another.
Describe alternatives you've considered.
I'm aware of this issue/PR, but the nuance is different:
This docs issue is also unrelated, except for improving the docs UX for new users in general:
pandoc.scaffolding
section in 'Pandoc Lua Filters' docs (RE: Custom Writers) #10531The text was updated successfully, but these errors were encountered: