QuantEcon / sphinxcontrib-jupyter

A Sphinx Extension for Generating Jupyter Notebooks
BSD 3-Clause "New" or "Revised" License
77 stars 23 forks source link

FEAT: Add support for note directive in documents #80

Closed mmcky closed 6 years ago

mmcky commented 6 years ago

It has been requested to add support for .. note:: directive.

When translating this to markdown should we impliment this as a blockquote and a forced bold Note: at the top such as:

.. note::

   Some text here in the .. note:: directive

would render as

Note Some text here in the .. note:: directive

or should through raw html which would allow it to be more styled.

I am leaning towards the former implementation for simplicity and readability.