From: William Lupton <wlupton-QSt+ys/nuMyEUIsrzH9SikB+6BGkLq7r@public.gmane.org>
To: pandoc-discuss <pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org>
Subject: Re: Tip: comments in Markdown
Date: Wed, 22 Jun 2022 14:57:03 +0100 [thread overview]
Message-ID: <CAEe_xxjAwFPZsCP3JMW+qHpfT2csgnei3pyE3RZT+aoUhYVwoQ@mail.gmail.com> (raw)
In-Reply-To: <CADAJKhAYoUGxuA-xFBp699zqrYHTARhTLCmPjZ2=BE2T7kO0GA-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
[-- Attachment #1: Type: text/plain, Size: 2968 bytes --]
it also works to use YAML comments, e.g.
% cat comment.md
---
# this is a comment
---
text
---
# this is another comment
---
% pandoc comment.md
<p>text</p>
On Wed, 22 Jun 2022 at 14:53, BPJ <melroch-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
> I don't know if I or someone else has mentioned this before, but I just
> realized that there is (another) simple trick to simulate "markdown
> comments" as opposed to HTML comments:
>
> ``````markdown
> ```{=comment}
> This won't show up in HTML output!
> ```
>
> `This neither`{=comment}
>
> <!-- But this will be in HTML -->
> ``````
>
> Theoretically this might break if there ever is an output format called
> "comment" but I guess that is highly unlikely.
>
> It will also probably work with your local language's word(s) for
> 'comment'; I tried with Swedish "anmärkning" (and the abbreviations
> "anmärkn" and "anm") and it seems multi-byte chars in the "format name" is
> no problem.
>
> Also if you don't trust Pandoc to automatically reject raw elements with a
> bogus format you can use a simple filter:
>
> ``````lua
> local is_comment = {
> 'comment',
> 'com',
> 'remark',
> 'rem',
> 'kommentar',
> 'komm',
> 'anmärkning',
> 'anm',
> 'athugasemd',
> 'aths',
> }
> -- Turn the list into a set
> for i=1,#is_comment do
> is_comment[is_comment[i]] = true
> is_comment[i] = nil
> end
>
> local function raw (r)
> if is_comment[r.format] then
> return {}
> else
> return nil
> end
> end
>
> return {
> {
> RawBlock = raw,
> RawInline = raw,
> }
> }
> ``````
>
> Notably this filter can be used to remove such "comments" from Markdown
> output, while otherwise they will remain when reformatting Markdown source
> with Pandoc, which IMO is an advantage over YAML comments.
>
> I hope this is useful for others,
>
> /bpj
>
> --
> 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/CADAJKhAYoUGxuA-xFBp699zqrYHTARhTLCmPjZ2%3DBE2T7kO0GA%40mail.gmail.com
> <https://groups.google.com/d/msgid/pandoc-discuss/CADAJKhAYoUGxuA-xFBp699zqrYHTARhTLCmPjZ2%3DBE2T7kO0GA%40mail.gmail.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/CAEe_xxjAwFPZsCP3JMW%2BqHpfT2csgnei3pyE3RZT%2BaoUhYVwoQ%40mail.gmail.com.
[-- Attachment #2: Type: text/html, Size: 5263 bytes --]
next prev parent reply other threads:[~2022-06-22 13:57 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-06-22 13:53 BPJ
[not found] ` <CADAJKhAYoUGxuA-xFBp699zqrYHTARhTLCmPjZ2=BE2T7kO0GA-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2022-06-22 13:57 ` William Lupton [this message]
[not found] ` <CAEe_xxjAwFPZsCP3JMW+qHpfT2csgnei3pyE3RZT+aoUhYVwoQ-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2022-06-22 17:48 ` BPJ
[not found] ` <CADAJKhDDy5y-KFmWcea6BwaL7S9Jk7piw-bf4RbYmBJtVQb2aA-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2022-06-22 18:47 ` William Lupton
2022-06-22 17:55 ` John MacFarlane
2022-06-22 19:12 ` Thomas Byskov Dalgaard
[not found] ` <332666C5-9B8E-42B1-A9D2-2437FCE7B70E-AHfMSizzl90sTMJHDOTzqX9LOBIZ5rWg@public.gmane.org>
2022-06-23 10:18 ` BPJ
[not found] ` <CADAJKhDBa8sm2VNKdQpdz_SsBvMYOfofJG-6-hjY6XrSL19nPA-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2022-06-23 20:21 ` John MacFarlane
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=CAEe_xxjAwFPZsCP3JMW+qHpfT2csgnei3pyE3RZT+aoUhYVwoQ@mail.gmail.com \
--to=wlupton-qst+ys/numyeuisrzh9sikb+6bgklq7r@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).