jgm/pandoc

Admonition blocks not converted back from html to rst.

Open

#4,511 opened on Mar 30, 2018

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Haskell (44,133 stars) (3,850 forks)batch import
enhancementformat:RSTgood first issuewriter

Description

Not sure if this is a bug or just an unimplemented feature.

Converting rST admonition blocks to html and back to rST doesn't produce the same rST syntax. Instead, there are raw inclusions. Tested on Pandoc 2.1.3.

It would be nice to recognize note blocks, like it happens with <pre>.

Here's a full demo: https://github.com/NickVolynkin/pandoc-admonition-demo And a short example.

Expected output:

.. note::

   Note text

Actual output:


.. raw:: html

   <div class="note">

.. raw:: html

   <div class="admonition-title">

Note

.. raw:: html

   </div>

Note text

.. raw:: html

   </div>

Contributor guide

Tech stack
None
Domain
documentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with Pandoc's ASTknowledge of rST syntax and writerunderstanding of HTML raw block handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate the HTML reader and rST writer in Pandoc to understand why custom HTML divs are not being recognized as admonitions during round trip conversion. The demo repository at https://github.com/NickVolynkin/pandoc admonition demo provides test cases. Consider adding support for mapping specific HTML classes (like 'note') to the appropriate rST directive in the writer.