public inbox archive for pandoc-discuss@googlegroups.com
 help / color / mirror / Atom feed
From: Lukas Atkinson <opensource-3R968MVE1sOAz21JXljZEw@public.gmane.org>
To: pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org
Subject: Re: Adding the highlight directive to the rST reader
Date: Thu, 13 Feb 2020 10:37:05 +0000	[thread overview]
Message-ID: <CAJTYOd3_psBu-hQtA0E43hozBu1-ZcM_up1Fh9ekTHMjV1c9dg@mail.gmail.com> (raw)
In-Reply-To: <9e025799-6d50-40a9-b8ab-a075437cb2b9-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org>

[-- Attachment #1: Type: text/plain, Size: 3076 bytes --]

From the perspective of a Pandoc user, adding more Sphinx extensions would
be extremely useful. Most RST documents seem to target Sphinx, and many of
the extensions are also really convenient.

However, this may be a case where it could help to control the Sphinx
extensions via Pandoc's extensions mechanism, e.g. '-f rst-sphinx' to get
the docutils behavior?

On Thu, 13 Feb 2020 at 10:30, Lucas Escot <lucas.escot-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:

> Hello everyone,
>
> I just implemented the highlight directive
> <https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-highlight>
> to the pandoc rST reader.
> This allows one to specify the default language to use when highlighting
> literal blocks.
> It is especially useful when writing rST in a literate agda or literate
> haskell file, where it is undesirable to have to specify the language at
> every code block.
>
> .. highlight:: haskell
>
> From now on code will be highlighted as haskell::
>
>   data Tree = Leaf | Node Tree Tree
>
> An other exemple too show how terse using literal blocks becomes::
>
>   main :: IO ()
>   main = putStrLn "Hello World!"
>
> We can change the language at any point in the document.
>
> .. highlight:: python
>
> So this block contains python code::
>
>   def main():
>     print("OK")
>
> An we can still disable having a default language:
>
> .. highlight::
>
> This directive comes from the Sphinx extended rST (which argueably is one
> of the most popular use case of rST out here, see readthedocs.io),
> this is why I am wondering *what is your stance on adding directives to
> the pandoc reader?* (which are not specified in the docutils reference)
>
> My opinion is that such an addition is quite reasonable, and most people
> use rST with sphinx and are therefore accustomed with said directive
> already.
>
> You can see my implementation here: https://github.com/flupe/pandoc
>
> If you all agree it can be merged, what is the process? Should I create an
> issue mentionning the problem or just make a PR?
>
> Best,
> Lucas
>
> --
> You received this message because you are subscribed to the Google Groups
> "pandoc-discuss" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/pandoc-discuss/9e025799-6d50-40a9-b8ab-a075437cb2b9%40googlegroups.com
> <https://groups.google.com/d/msgid/pandoc-discuss/9e025799-6d50-40a9-b8ab-a075437cb2b9%40googlegroups.com?utm_medium=email&utm_source=footer>
> .
>

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/CAJTYOd3_psBu-hQtA0E43hozBu1-ZcM_up1Fh9ekTHMjV1c9dg%40mail.gmail.com.

[-- Attachment #2: Type: text/html, Size: 7329 bytes --]

  parent reply	other threads:[~2020-02-13 10:37 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-13 10:30 Lucas Escot
     [not found] ` <9e025799-6d50-40a9-b8ab-a075437cb2b9-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org>
2020-02-13 10:37   ` Lukas Atkinson [this message]
     [not found]     ` <CAJTYOd3_psBu-hQtA0E43hozBu1-ZcM_up1Fh9ekTHMjV1c9dg-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2020-02-13 12:44       ` Lucas Escot
2020-02-13 16:29   ` John MacFarlane
     [not found]     ` <m28sl6sb6q.fsf-pgq/RBwaQ+zq8tPRBa0AtqxOck334EZe@public.gmane.org>
2020-02-14 19:44       ` Lucas Escot
     [not found]         ` <a6188c4b-d574-4fa3-b0ec-a5f1fd6e03f9-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org>
2020-02-14 22:40           ` John MacFarlane
     [not found]             ` <yh480kh7zskd1g.fsf-pgq/RBwaQ+zq8tPRBa0AtqxOck334EZe@public.gmane.org>
2021-01-15 23:04               ` Peter

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAJTYOd3_psBu-hQtA0E43hozBu1-ZcM_up1Fh9ekTHMjV1c9dg@mail.gmail.com \
    --to=opensource-3r968mve1soaz21jxljzew@public.gmane.org \
    --cc=pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).