[QubesDoc] highlight trac-wiki and Axt-Style formatting?

[Jeremias E.]

Hello,

is this code just a relic or is there any reason for using it after migrating the wiki from trac?
{% highlight trac-wiki %} qvm-grow-private {% endhighlight %}

can this relic be replaced with the markdown coding style?

```
code comes here
```

the other question is related to the headings. Some of them are in Axt-Style others are not. Is there any reason behind that?

Axt-Style:

# Heading H1
### Heading H3

Non-Axt-Style:

Resizing Disk Image
-----------------------------

is there a prefered style.
I mean I prefer the left handed Axt-Style.

Is there any guideline for Wiki-Contributions?

Best regards
  J. Eppler

[Marek Marczykowski-Górecki]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On Fri, Sep 18, 2015 at 01:29:39PM -0700, Jeremias E. wrote:
> Hello,
>
> is this code just a relic or is there any reason for using it after
> migrating the wiki from trac?

> *{% highlight trac-wiki %} qvm-grow-private *{% endhighlight %}

>
> can this relic be replaced with the markdown coding style?

Sure, we're fixing this when updating pages with such relic. But since
it's slow process, it would be probably better to fix all of them at
once, preferably using some script.

>
> ```

> code comes here
> ```
>
> the other question is related to the headings. Some of them are in
> Axt-Style others are not. Is there any reason behind that?

Yes, it isn't possible to create H3 in Non-Axt-Style. Or may be I'm
missing something?

> Axt-Style:
>
> # Heading H1
> ### Heading H3
>
> Non-Axt-Style:
>
> Resizing Disk Image
> -----------------------------
>
> is there a prefered style.
> I mean I prefer the left handed Axt-Style.
>
> Is there any guideline for Wiki-Contributions?

Yes, here:
https://www.qubes-os.org/doc/DocStyle/

- --
Best Regards,
Marek Marczykowski-Górecki
Invisible Things Lab
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBCAAGBQJV/HsZAAoJENuP0xzK19csN7EH/iJ9NWqOc4mKP3nTwl/PWbhK
gOr++qvzLfhSc5CXYBcER62V0X6L8gyYVNjya7ErOJ73IIiwTDQ0shg7riGda+3x
aBzBBmTehLgSzoeieEnxElb+n9wc/MiIad87JF1iFiVm7ucYEr0mzCYJfEVbM3Vn
OPswPrYocWUQynIo8VbfH2f+I/M7AGbq9askf72gIhxzfpYRXmbyHzSPnZ7886Hh
75ERdpKoshQJDY4V1ocOZ3AZUJC4gfck4M8Y5GyPPhtqlMdKleuZBOb7RJ/ZOPit
r5w2xFo/7+aO7Ndv25NJD9ql5nbm124DWID4DOhl0B0fi++2W9AGqIl4qa6VWPk=
=O2Rb
-----END PGP SIGNATURE-----

[Jeremias E.]

Hello Marek,

thank you very fast response.

You did not answer my question about Axt-Style vs. Non-Axt-Style.
What do you prefer or better what should be used Axt-Style or Non-Axt-Style?

I will create a script to remove all {% highlight trac-wiki %} qvm-grow-private {% endhighlight %}, let this be my concern!

Best regards
  J. Eppler

[Marek Marczykowski-Górecki]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On Fri, Sep 18, 2015 at 02:10:17PM -0700, Jeremias E. wrote:
> Hello Marek,
>
> thank you very fast response.
>
> You did not answer my question about Axt-Style vs. Non-Axt-Style.
> What do you prefer or better what should be used Axt-Style or Non-Axt-Style?

The preferred one is Non-Axt-Style (more readable while reading markdown
directly), but as noted earlier some places needs the other one.

> I will create a script to remove all {% highlight trac-wiki %}
> qvm-grow-private {% endhighlight %}, let this be my concern!

Thanks!
Take a look here:
https://github.com/QubesOS/qubesos.github.io/tree/master/_utils
There are already some similar scripts.

- --
Best Regards,
Marek Marczykowski-Górecki
Invisible Things Lab
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBCAAGBQJV/ID/AAoJENuP0xzK19cs8WMH+QGupD1zKBbx8LbLSJf7AdwP
gpW6b7nDpi4zCIZhBooHLjuU7FpJUne2zY9ZAgJ9xtH9urlsZHn7QXmNUllqwOwF
H8KH/uYgp0QJYPN5o3r8PwzSbQF+MAF0OhUdny4t74eM/MWKPLCWUTm9XD2fvUKP
iCHmak5vzq1fUXbmzc2xaq+oDD4ePDESYh0Zb8uxJnKN8BY/eCKjoELdbATIHsqJ
I9ddo18jhvvmYjSORF4xm6ynppuPeMvF+vyjZID3UDhWgHZSxE/xIGehMmvcAMkA
VUXy1YIXFdTkUO29/aEoAcGlfKDCwSKoVayd5d77dy6/xkXgzQOK24lDfP0Gv6E=
=N6Jp
-----END PGP SIGNATURE-----

[Jeremias E.]

Hello Marek,

thanks for your answer.

I am sorry, it is not called Atx-style is called Atx-style.

Best regards
  J. Eppler

[Jeremias E.]

Hello Marek,

I have replaced the old trac-wiki relicts and I added a pull request
to the qubes-doc repository.
I additionally created a pull request to add my bash-script to QubesOS/qubesos.github.io/_utils
repository.

Best regards
  J. Eppler

[Marek Marczykowski-Górecki]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On Sat, Sep 19, 2015 at 08:28:43PM -0700, Jeremias E. wrote:
> Hello Marek,
>
> I have replaced the old trac-wiki relicts and I added a pull request
> to the qubes-doc repository.
> I additionally created a pull request to add my bash-script to
> QubesOS/qubesos.github.io/_utils
> repository.

Thanks, great work!

- --
Best Regards,
Marek Marczykowski-Górecki
Invisible Things Lab
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBCAAGBQJV/ipbAAoJENuP0xzK19cs1ZgH/AqnArGqVpnZi5nI/1nsWJfH
58CWQZKVziyhA4ZwT/MPaplVKW9iMGy/tHUIp3Ak3f3doVImsxnb/zg8OJkmy7Dq
XErbr5OVXIdJQ7qlfh3/UdgSkgMs0hcC4DB8l4Xfp8fdMLVwNHR+wshiO64OXXfF
JwqxqIZC7jnhoFY2hnGxXCqSG6yAJSh6nCtRnTxXcUhKJSv1g9E928XRSmpzLaeF
q6jdNEORgC5Nxix45LmIfgDRxlHFvsITF0xdeQ5Bbhqn5fEyFSIy01QCOyc5MmeV
nuXPmfshJV98WlYBTnFF7u3z/UuMNgdreVYmtMLJjGlcMT5v9Em18U+UIPfIRZA=
=rmkk
-----END PGP SIGNATURE-----

[Axon]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Marek Marczykowski-Górecki:

> On Sat, Sep 19, 2015 at 08:28:43PM -0700, Jeremias E. wrote:
>> Hello Marek,
>
>> I have replaced the old trac-wiki relicts and I added a pull
>> request to the qubes-doc repository. I additionally created a
>> pull request to add my bash-script to
>> QubesOS/qubesos.github.io/_utils repository.
>
> Thanks, great work!
>

Unfortunately, this change has destroyed code block rendering. For
example, look at the code blocks on this page:

https://www.qubes-os.org/doc/UserDoc/SplitGpg/

With our current setup, the code blocks have to be space-indented in
order to render correctly. For example, this:

https://raw.githubusercontent.com/QubesOS/qubes-doc/ad48b274e4a67cdb4936
e3fe7614cf3043b0f6ce/Multi-factorAuthentication.md

Renders like this:

https://www.qubes-os.org/doc/Multi-factorAuthentication/

Can the script be changed to suit this, or should we (if possible)
change our config so that the "```" syntax is better handled?
-----BEGIN PGP SIGNATURE-----

iQIcBAEBCgAGBQJWAAeBAAoJEJh4Btx1RPV8QWUP/3NkU7FQFYRQ6wlpiZh/+yGP
Oickaxzn9igr37O4iCRux+Y6TmOoga8XkcW4TFo2ve9G4evcfkZ7irp597VbYfQi
mOmcdpXO6MCd8/zd1aOu7s55YdIkT45ArFVvBb+eWMxS4qh/bRGsZ+HtGLqC0Lh6
iqyJTNngtyEK25ebZL/bSyVCXlBj3nkwVzNJMAhiX9QFS1I7wZqvWZDhFyNTcwd0
Vsy7H5ouG5bodyyjen6LMKXL+FsipK8kKKRBYQVR55BnpC2Dd/MTJZ7lKNgV3Ft0
p82EFYdWe2v8BOtmHmKy2LobdAQyRv1rPjcRndxJYcW7JMSUuuqEWhiPV1RiuiLU
fYBQ0w8erb5jGT/9LeyKFNOksFup2rvC4sD46h3Ju5olcotTGgJudHZ6ITTGTF/r
LxVVYrjZSkqRp3asUlM4ch5Z5YbDDQXO3pR9/38mQf9OFPRZbhaV6KQ2V1YJfo9o
S3AcVob+m0v7JMu8DCJHCEZdNAtuYtaiIyTVsnYF/MnGWE+PP2WtO0RuuZIZcfL+
mXshk6cY40/AihLX3hO/VKR3OEsr/f/guo0n+RfT3BVhmbeOLl7cLXFme8CZhglZ
RZZy9pMD+LKGYYDuy6tRcssOxTFwGPw+S1+Luhi40/rbb2/7Zxv+g/b/xaYRhawL
ojFRmAhPjVqKFdwYzLua
=MUye
-----END PGP SIGNATURE-----

[Jeremias E.]

Hello Axon,

thank you very much. Have you found more of this errors?

You can use both, indention or ``` the question is what is better?

I like the following github flavored markdown syntax more:
```
code here
```
instead of:

  code here

I like the github flavored fenced code blocks more, because you can do things like:

```python
python code comes here
```

Unfortunately, this change has destroyed code block rendering

This is not true the problem about your specific error you found is that the code continues directly after the fenced block, there should
be a new line after every ```

I will search for all ```[a-z]* errors.

Best regards
  J. Eppler

[Jeremias E.]

Unfortunately, this change has destroyed code block rendering

This is not true the problem about your specific error you found is that the code continues directly after the fenced block, there should
be a new line after every ```

 
I investigated this error again. I could not find the why the result looks like this:

``` [user@work ~]$ export QUBES_GPG_DOMAIN=work-gpg [user@work ~]$ gpg -K [user@work ~]$ qubes-gpg-client -K /home/user/.gnupg/secring.gpg —————————– sec 4096R/3F48CB21 2012-11-15 uid Qubes OS Security Team secu...@qubes-os.org ssb 4096R/30498E2A 2012-11-15 (…)

[user@work ~]$ qubes-gpg-client secret_message.txt.asc (…) ```

it looks like this in the .md file:

```
[user@work ~]$ export QUBES_GPG_DOMAIN=work-gpg
[user@work ~]$ gpg -K
[user@work ~]$ qubes-gpg-client -K
/home/user/.gnupg/secring.gpg
-----------------------------
sec   4096R/3F48CB21 2012-11-15
uid                  Qubes OS Security Team <secu...@qubes-os.org>
ssb   4096R/30498E2A 2012-11-15
(...)

[user@work ~]$ qubes-gpg-client secret_message.txt.asc
(...)
```

if you run:

~$ cat SplitGpg.md | grep -E "\`\`\`" | wc -l
10

the ``` occur 10x means 10/2 -> 5 code blocks using ```, but only one is rendered wrong.
If I open the same file with the atom-editor and use the markdown preview feature the above mentioned code
block is rendered correctly.

It is not clear why this error occurs.

I looked around and found 7 pages with the same error till now.

Best regards
  J. Eppler

[Axon]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Jeremias E.:

I think it's because our Jekyll setup only supports standard Markdown,
not Github-flavored Markdown. In standard Markdown, you must indent
code blocks by four spaces (or eight spaces if in a list). By
contrast, in Github-flavored Markdown, you can use fenced code blocks
(```).

I noticed further evidence for this hypothesis just now when I
attempted to create a table using Github-flavored Markdown syntax.
Standard Markdown does not support tables. Sure enough, my table does
not render as a table on the website.

In any case, I have manually fixed the code blocks on this page:
https://www.qubes-os.org/doc/SplitGpg/

-----BEGIN PGP SIGNATURE-----

iQIcBAEBCgAGBQJWAZG8AAoJEJh4Btx1RPV8NjoP+wXt9vTiSR4OnZIIGkZCYNtD
A9bEr8NJPpM5t2LQxl6xB6tRlP5dFrJQvk/QbQ0dKh8kfFp0OQuSDwFY/GaNKJDn
0wOT36eLH7IbG7fWFskhHTqdePo6pwYVHm+7tvcQUq/D3x0HDrm22n6bDPhincOE
IRJcxya4ogGclgstNK8yOGo5P+/w7G+tCsMDC378ZDqbljdxCQq3jkwEGTI4j+VL
DNw+WJz1fnHeU8q63rv+bp2av4U+Wop4EQNkEsbUgVySB2neJ1aF48sMQYtA1mgj
dCqhOya+MdwnUbaT/cw1BYFECof0bF6Xr1A5KvL+Pto3WCn0QyAb0DF2IKDgX0Io
n/O77rZ6Vc5O8ee51+pS4l7ujmw5R3cSUJesjNixloJpaU5Wrn+svvP3ZnSxT7FH
rGuXnkykAj3crR8SuidoVLx6RmfzwIsSLnqbu7/lKD5uec9j36rAbFVBZFGaOpRf
nkK5/w/LureNHOt73H04g4eIOP9HHBf8SrT2JD4ZJnEfKuSARX0XyPl2x3slKarT
GhRO9RnJcsnZaHkZE0savHg+jUbCjNgABYv3dqMteM3zVusQjY8ij4YnNV2iUAjI
IaCTkmSruendoxYtl+XYsj+6K1VOcjZgWt1GV9+dxI310ljH11mRUDzvAYpXZYFs
nBwxtxQXSIhMD1twsNHr
=iBON
-----END PGP SIGNATURE-----

[Axon]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Axon:

Actually, I take this back. I think my table actually is rendering as
a table, just not a very pretty one. (It has no lines.)

So, perhaps Github-flavored Markdown is supported after all. But then
I still don't know why our fenced code blocks aren't working.

> In any case, I have manually fixed the code blocks on this page:
> https://www.qubes-os.org/doc/SplitGpg/
>
-----BEGIN PGP SIGNATURE-----

iQIcBAEBCgAGBQJWAZMPAAoJEJh4Btx1RPV8eGAP/0RxL2F1IJ8vdmgtJ0eqAVOA
nlLfEfcn4vx7C9ah+lxBy2EJ2MUNyv7kHo51WTlxhmsIGAAebGICN9sJb//LW+ur
8TjREP21MkAAl9nc/ZFNTKbgP5RGK7OmYymnlWz/7ofJkCkH8jfE+5K1KRAo5KN7
5iWFc56Fdu9QqSuWd/4qsI6fIo8qrf+27p8kst38ugRCECa/qBRX/MOhBDmEiSJR
RX6rEq2ziPMZgLGxDd8li8ibLZwd+cpv1r2GbNnljsd/Fza+r1XsYXLZivMdoRSM
SAbt5iKBW+Dgcz6ImARMh8MVcU6E9x317FBvJNJCvlwrHBaBulKJK/MaE2ox+HFX
UFgL0Y2Zz5aqZ/V3oh1Q+APMIUq+2xf2h8RgpU1DeRgpZ2+UhTG2qUFzko+Xw354
IqNXmXqTo/EdexBDzaUEsy9dycrUWene1Ha+RdpmpRUcM/4PbR6FbLpyg6YVk6eE
F9O0QEZBRYwtfmGMLXiU7CKx2LBwfrAqyMgvRs5CJ66sU468Gt89WkdUMxM2At+g
gd4jz/FTgxIrBkPO+1VMMStuxveQcJRQ0jGHs71DR+dYi9OtWhIMuOneN0bvZVuT
oCrqUDmcnjD5xoBuLlt6IZRyEvy5ki6dUNnNyWKvNov17bg+iiDGO3BVQUcNHd5R
/ehkASzNHiOEcbEk4HF9
=ZHqi
-----END PGP SIGNATURE-----

[Marek Marczykowski-Górecki]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Regarding table - I have the same problem here:
http://www.qubes-os.org/doc/releases/3.0/schedule/

> So, perhaps Github-flavored Markdown is supported after all. But then
> I still don't know why our fenced code blocks aren't working.

Maybe some missing setting/plugin?

- --
Best Regards,
Marek Marczykowski-Górecki
Invisible Things Lab
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBCAAGBQJWAZd6AAoJENuP0xzK19csm4QH/20AqFzvTbmu17KKiwGPMkiW
3odu7/aNcJFWNRDyJe1MX/QeEIcsq2oIAxtLaatD4lngHpltGsTgReWiR8D4zryX
2imJAcEEUgubdwlp+EzmZshdhNYGQsUMX/JYby6FWW31A9jMc6BYrkw3yKhc6xhU
aAu9XFO8OKjsrKY/hBQwpY3mfEtsNslzR8SdnpR/Y/lNdfB1aAVHuXV3xQ7UlY1i
5aFYHFW8ZhsvJ6ZIaPBY5M7tMj1kBKA863Yay/DjEOws1FxOEVnm9krxuNd5pJOy
T4oG2G2cVJLwl3qDgdfVuEt217Ez+JD5YnZD102O/iSdVff9NYJf8f1aAiMegZE=
=AkQf
-----END PGP SIGNATURE-----

[Jeremias E.]

I replaced many old track wiki, code blocks with fenced code blocks. The surprising thing is they work in most cases,
but sometimes they don't work. Both working and not working at the same page, like here: https://www.qubes-os.org/doc/UserDoc/SplitGpg/

[Axon]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Jeremias E.:

>
>
> Am Dienstag, 22. September 2015 19:42:58 UTC+2 schrieb Axon:
>>
> Axon:
>>>> Jeremias E.:
>>>>
>>>>
>>>>>> Unfortunately, this change has destroyed code block
>>>>>> rendering
>>>>>>
>>>>>> This is not true the problem about your specific error
>>>>>> you found is that the code continues directly after the
>>>>>> fenced block, there should be a new line after every ```
>>>>>>
>>>>>>
>>>>
>>>>> I investigated this error again. I could not find the why
>>>>> the result looks like this:
>>>>
>>>>> ``` [user@work ~]$ export QUBES_GPG_DOMAIN=work-gpg
>>>>> [user@work ~]$ gpg -K [user@work ~]$ qubes-gpg-client -K
>>>>> /home/user/.gnupg/secring.gpg —————————– sec 4096R/3F48CB21
>>>>> 2012-11-15 uid Qubes OS Security Team secu...@qubes-os.org
>>>>>

> <javascript:> ssb

>>>>> 4096R/30498E2A 2012-11-15 (…)
>>>>
>>>>> [user@work ~]$ qubes-gpg-client secret_message.txt.asc (…)
>>>>> ```
>>>>
>>>>
>>>>> it looks like this in the .md file:
>>>>
>>>>
>>>>> ``` [user@work ~]$ export QUBES_GPG_DOMAIN=work-gpg
>>>>> [user@work ~]$ gpg -K [user@work ~]$ qubes-gpg-client -K
>>>>> /home/user/.gnupg/secring.gpg -----------------------------
>>>>> sec 4096R/3F48CB21 2012-11-15 uid Qubes OS

>>>>> Security Team <secu...@qubes-os.org <javascript:>> ssb

No, that page is only working now because I already manually updated
all the code blocks (replaced fences ``` with space-indentations). See
the commit log.

Can you point out an example where the fenced code blocks are
currently working? I would like to try to examine it further.
-----BEGIN PGP SIGNATURE-----

iQIcBAEBCgAGBQJWAc+tAAoJEJh4Btx1RPV8EfQP/iXA86J2e3cU6qxZuevhZsF0
r19VC+fKJYC4G94c0LjQsJ+HRmaNhub4Gu3JHgKnQp2sSeQAVc1sF+e9jhQW+gGO
QCIhCz99m/iwwiBocHPrXvTwkWn77+/hLEcDJFo7zyUf/4O1VXELA2MnGg/RyoIi
w5Ks0BsrSiQYs1QLHhemDkviI9juGv0hiU0FL5W7IUTi/sUXqeGOByLZoqgdFVqJ
cHsrBbMLDavbVDb3XMABzXhbQX35X3H7vPtrEKb95+fGZJthIMlYMATDivY0wvKR
ZMoY6OBjITl0FO7kgZQgDyvBkZed/TsAL/QaktC3YDMbLt+engxuzRaOvhbkA+9X
/uuuH1OqS+yYYOFMnudYDBHVMd+zLvfWBBG8bGlluFw4XnabGYs5ydV65QRpMBOr
kGU/4euFD/NzapakBCw4GEkg4ni8gvnElsyGvy4CSAevFro5Yy99AXI8NYngLiV7
jSmYUxLjzd8JyB5wBik9Zctz4C/Ygq7/3Jgl8oE+xIaw0kgI+5bUqSbGhPvX4czQ
nkQ7y6AAKkNEnwzzXavD2VgTRXdzbnq5Fuh4+VjucacSBNKZGstCIFyQwa0l+c95
msDLLjLb/GEZ9RbKIlElTflgpFcRhAx5mumsyECS2FFoGsRTyigGOAd1jHeXq4Xi
jky1EofsReZwCOJpmapS
=6RSl
-----END PGP SIGNATURE-----

[Axon]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Axon:

It seems to work only on single-line code blocks, not multi-line code
blocks. The only way I've been able to get multi-line code blocks to
render correctly is by space-indenting them.

I think we should consider reverting the change until a suitable fix
can be found, since it makes multi-line code blocks unreadable.
-----BEGIN PGP SIGNATURE-----

iQIcBAEBCgAGBQJWAdFjAAoJEJh4Btx1RPV8XqIQAMEpY8nWsIGQ8jPTWoKAgWTE
e0/60ndeHDmIDfb9DtYH9jGqdE1YFfK070TxeTLKWpJ3EtxcwwCaTXREVqh3XNJI
OLBoWUPylsaX2kR8Meagm9PkiUro7U2UjSB+5WAzjkxR4MBUmoxMHczAZO7DAPQB
qABTIZ+v4vKMn+qlgck4DCpbhPff7OpgckGnXqd927CelhdcMjWh0uef6esSI4eJ
qRePoYqlMkuaji+J6hG84lq1z35VeVrvfufMDHxuOLd0ICrbS1RolUcpUkVW4lqN
Wm4fBYLokFRiodQOsuTcDc+2LThjot2ozLh1qXWDbFBF/R4jmUKXUBXR7l5SVCEf
8MGasvNVcCSgcuwhTd/kxsV+ju8K+vUC3l7/PNj7rMr/ey8c5CSQyGHjJn5WmR5K
03P5Npy3iywfMxTqh0CdFat7GHh+J4ClzD3oqsYRl6QtPYgRU+8DEyJEsQ5yCAQv
sxLTHv56Gxu5mSMfoU4xywWBFBw3QGgn16pzJh1e/LAAfywIHxsS9t2aKzhUE4VO
tI4YBDvuQ9F/U61ykXaYacULSfr2CuBQ8EvTlp55TfRGjYOVeAug05cLBxO5WYRA
1Y1uhx8jDD5WvGWfPgUtGqSu/OoAIL4ESjxZLi9e47rwdwqT3wHCoUKFir6XB7Vh
iRCjO4K2FWw/fbGuS6V2
=ePch
-----END PGP SIGNATURE-----

[Jeremias E.]

I will replace all fenced code blocks with space-indenting.
How many spaces do I have to use?
 

[Axon]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Jeremias E.:

Four spaces (eight spaces in lists).

But actually, I just figured out the cause. It's because we're using
kramdown in _config.yml. Changing from kramdown to Redcarpet fixes the
fenced code blocks.

@Marek, @Nukama: Does anything depend on kramdown, or could we switch
it to Redcarpet without breaking anything?
-----BEGIN PGP SIGNATURE-----

iQIcBAEBCgAGBQJWAdOnAAoJEJh4Btx1RPV8Qf4QAOMtFtLl/g8XfPysnULPpdWG
c2MkRQY1qc00S3jCNdPVcrK5haG1tL0UkmJmeRFRRFUmwCQxyF/PYITpmBtzK+tl
+Zhb3Rl5htvHkmC7YdnOGEV+dT8tPb4OvdTrPmzVi2J1opCKZHiZ6rsPj6Vln4Yw
gbuyXcXsOwukHKhVyH72memMHBAgbeTHdL7dpJ5X8sEsGoGJMHaUtZyqtKyIInY1
DhYbElXSm8sQDicYA6mvf7xmRPyyQ3ocwyRAWx8gHpsm5HtNIpjezSXnN/PteqIT
Hrg9T99euDvt/sMIcvCbiyx4sdYORtH3rIL0S/rbOJe959MDahWoaVWjLkNe7f8F
KIUnLg27qwJ9Wjc9N0656ELA3dn2HXV6xhnmqDFNz12T0ahcmNffUnBkmnZIAKve
9B8wMrgPrcl07VcIELR90o/QqfqQvR7GN2T0BFy9dIcyjJZu2joafs0UHSvW/Kr9
idE2dZG++nU2P+4qj+ZHYKYYA8YFM9Yn7JDY2xUXto6otfBFrMbKTIpkON5gQUb2
t3/ozheQHwdlTZy4ccZkUFiGqXMvB0CY2E9phpmVQZgwGDZpPCEUdsW/jtJSsTIQ
T4NWdIO/2OKXCO67iUn1L3kaW3IZs2IZfmRXlPKklBeLZsS4Ya8shPqXvk/4cJXw
gCm5aEufv/OrfdU5xrwU
=XiZi
-----END PGP SIGNATURE-----

[Marek Marczykowski-Górecki]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On Tue, Sep 22, 2015 at 10:18:27PM +0000, Axon wrote:
> But actually, I just figured out the cause. It's because we're using
> kramdown in _config.yml. Changing from kramdown to Redcarpet fixes the
> fenced code blocks.
>
> @Marek, @Nukama: Does anything depend on kramdown, or could we switch
> it to Redcarpet without breaking anything?

I don't know. Does changing to redcarpet also fix tables rendering?

- --
Best Regards,
Marek Marczykowski-Górecki
Invisible Things Lab
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBCAAGBQJWAdWEAAoJENuP0xzK19cs4ukH+wfTp4v4FBw7s6riS6GTlWm7
VnpDHrTlvydabea6Eo4BZIcvK02vdnlJwqs8ccDZtDaSsAo40wMfDuU9uT+Slw4d
aKVinulecS3No1E3R58UCdJbWxMwJM+dZB1h6etxbebGnmVVZEFpJppJTLQLZaMs
xgULZ75LIY/AcTX9j93Hiyh4sDLxp4sxabfs7mK4hrovfbx92vOMyQT/aAbQ4jMW
NwaSNe34XMQXoeU2CE73aTLZd0vLSUejOV8hGKJcc7xlEVnIQVVLlkNS8ESyDQjl
TDaUmwdJGiWQhylJduo3FWNl6TKpqfPuii9cMhqxRvGiulhRaDhWosDZGDgWR7Y=
=Q3N3
-----END PGP SIGNATURE-----

[Axon]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Marek Marczykowski-Górecki:

> On Tue, Sep 22, 2015 at 10:18:27PM +0000, Axon wrote:
>> But actually, I just figured out the cause. It's because we're
>> using kramdown in _config.yml. Changing from kramdown to
>> Redcarpet fixes the fenced code blocks.
>
>> @Marek, @Nukama: Does anything depend on kramdown, or could we
>> switch it to Redcarpet without breaking anything?
>
> I don't know. Does changing to redcarpet also fix tables
> rendering?
>
>

Oddly enough, it actually breaks tables even more.
-----BEGIN PGP SIGNATURE-----

iQIcBAEBCgAGBQJWAd/hAAoJEJh4Btx1RPV8FZkP/3kK9ioOTtwseqXPfVRP1S2g
JZhdZZyisfRSXeVqNrjcAlror/nF0gzs/Fu+DD5MudnPsy0PsGKMrp8uaOhdw66O
+3ks8MaKysL9iDRlfflQM0U1/gPLlSMUGp0rRNidc+1A0hQHuEyOsTJUvxaeDVOg
hVHRK7Y/K/k6fMOV5YxaMVkK8PTDBooAQRElS869ysWl958a/1DHOecrMS9dGR37
vwK/+1oflPFq0zznw3ycazuhRN0o3ern+bz5EfZHjQ/kr1CE0G+f4s1mcxSd9bvZ
yr0xotdT1m42H6GvNt1P9Px9lKSOEhLH1T/pxsV99mTNZgsvM2FAMCwbqPr/+hvV
WGOefqkOjt4ybramx6hBXB3htgBx5uerC6hQmXvUruzr6DUyruq7Y4NPrsTsjnsC
uTLhv7oCiigHr2whMlvCqvFLN/QoQ1mRC2pKSr4Dn8/k3z37RH4jjhQ9rZg4xUOa
U2pj2bIfiD+IXduePPRvRHD4AahZyHBUjoKdt6xmoRGeBLvzo8+udunT/zzCBSI7
4GgXI+WFo3Y4jrHqQuqbeRCN6cIxIh6tqlGUsjAACeE6PTF4QhEPp52h4o14dJEQ
OvEAwCuwZT4+x7+S+gpPkRNFZBJ4UNTDCnMsdKlNewi0MTu8LPqRB6SWcDpCuSdn
p8xbl6yslGbTkTnFuSlc
=K3O7
-----END PGP SIGNATURE-----

[Marek Marczykowski-Górecki]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On Tue, Sep 22, 2015 at 11:10:27PM +0000, Axon wrote:
> Marek Marczykowski-Górecki:
> > On Tue, Sep 22, 2015 at 10:18:27PM +0000, Axon wrote:
> >> But actually, I just figured out the cause. It's because we're
> >> using kramdown in _config.yml. Changing from kramdown to
> >> Redcarpet fixes the fenced code blocks.
> >
> >> @Marek, @Nukama: Does anything depend on kramdown, or could we
> >> switch it to Redcarpet without breaking anything?
> >
> > I don't know. Does changing to redcarpet also fix tables
> > rendering?
> >
> >
>
> Oddly enough, it actually breaks tables even more.

I've checked for the tables and found only few of them:
_doc/GUIdocs.md
_doc/WindowsTools[23].md
_doc/QubesNet.md
_doc/releases/3.0/schedule.md
_doc/UserDoc/SplitGpg.md

The tables in GUIdocs.md are broken badly (most likely because of
multi-line cells), but rest of them are almost ok - only missing
borders (probably some CSS issue).

So we have two options:
1. keep kramdown and convert all the code blocks
2. change to redcarpet and convert those few tables to HTML directly
(assuming that is an option)

For GUIdocs we'll probably need HTML anyway.

Any other pros/cons for redcarpet?

- --
Best Regards,
Marek Marczykowski-Górecki
Invisible Things Lab
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBCAAGBQJWAePxAAoJENuP0xzK19csqoEIAIdyuFhnxf2/h5WD14h0E8sf
8yF7IJ82XsGGBcYW+Af+3udU7LOuISJpmCPMVD1lrdJh6PW/+NR1t2XX7RDKLkDk
FjlIHgCZcKMh+qVgLabaFvNqY32ProHYgeSR3dFJzFBEag64JBMIO7TDXWWh/qLK
UDSAl1Nfh0bo2qfpPY1PWWrhkV0cWMtBMyl9FuLcowyt7ujHMhAnB4Pdf2upP0Mr
pRVO01P5IshFNspGyk4IhaFKRCwERBwp0Mh2+m+sMh0xuZr2Q5OJNOHvlN+Htd+z
O79SswB963p+BbeitI5uFtiMn/lgJ11dw7mvGSGgIGRba19fYoowjcTLIhOWp2s=
=nm53
-----END PGP SIGNATURE-----

[Jeremias E.]

Kramdown supports GitHub flavored code: http://kramdown.gettalong.org/parser/gfm.html

But since the basic markdown code blocks with four spaces are supported with every markdown
I will follow Axons example and convert all fenced code blocks
to standard markdown.

I don't understand why markdown has not a nice table support, maybe LaTex like.

For GUIdocs I would say the best option is to use HTML.
 

- --
Best Regards,
Marek Marczykowski-Górecki
Invisible Things Lab
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBCAAGBQJWAePxAAoJENuP0xzK19csqoEIAIdyuFhnxf2/h5WD14h0E8sf
8yF7IJ82XsGGBcYW+Af+3udU7LOuISJpmCPMVD1lrdJh6PW/+NR1t2XX7RDKLkDk
FjlIHgCZcKMh+qVgLabaFvNqY32ProHYgeSR3dFJzFBEag64JBMIO7TDXWWh/qLK
UDSAl1Nfh0bo2qfpPY1PWWrhkV0cWMtBMyl9FuLcowyt7ujHMhAnB4Pdf2upP0Mr
pRVO01P5IshFNspGyk4IhaFKRCwERBwp0Mh2+m+sMh0xuZr2Q5OJNOHvlN+Htd+z
O79SswB963p+BbeitI5uFtiMn/lgJ11dw7mvGSGgIGRba19fYoowjcTLIhOWp2s=
=nm53
-----END PGP SIGNATURE-----

Best regards
  J. Eppler

[Jeremias E.]

Hello,

kramdown also supports fenced code blocks with ~~~ three tilde instead of three ```  (see: http://kramdown.gettalong.org/syntax.html#code-blocks)
This would be an easy change.

[Axon]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Jeremias E.:

> Hello,
>
> kramdown also supports fenced code blocks with ~~~ three tilde
> instead of three ``` (see:
> http://kramdown.gettalong.org/syntax.html#code-blocks) This would
> be an easy change.
>

Good to know. As long as code blocks display correctly on the website,
I see no problem with using ~~~ fences.
-----BEGIN PGP SIGNATURE-----

iQIcBAEBCgAGBQJWA76gAAoJEJh4Btx1RPV8TXYP/jzZqM5w9CE0YmXugH+jNLPs
nAAgHE46eUpcVgsbVqRs/e1EvTW58wlr4aKjn+R3bY+xKZUWCr3s8CheZKFpQD9h
z10xDbUroz510+lV8EBkxtYZ5Ka18CdVeQLtP8f9c4ZRqAw0pdeWfTSvooKyv7fd
MI4yIEqJXTmuK8k+fBe70Y8AM2CkDDWlE+5cluWl89PgsJlb2BxIL6AJcKcEFMfn
7X4DQF0vML6bNN+ZUgejE5Bi4H96P+BrjLewmaOyeVZaUanGthM1HUFxU46HnUQj
5zTi9FOmexrCBibcKr7TaNKYNyPtoB1GFoCFUxCFtpx401TAy3iK3iWFV6CKNjSL
aM3YD+8KRkSl/GigOOYEI7vWgjdNqZJhoCbhSVluDXDhD2rQrvD4ZpQZnHP+r7h0
2oWq4jucBL3r51ol4fp2x38BDJrdU576DfbcJCFiFpGEnPwFaCEm0CyVPCT3ntSY
C2Zacs91MJphQ9Ea2iDttYtdPgVjgTeTgOzI4iZ8wjXPSd8hDTG+OzAmUqE9bLug
YK7SCzi2oBWUfY8Q0UtuRwxmF0CTxVZGkWZ48qEkGEebfgbX1GOaNf4tDNzlIy9E
h0LVHmE7V/hdfL+/mUSZjyG4LyCJd88sAccO+EIsKMZJ6JqR1qU3tldgvlFxqUhI
Q67mv4gPZkRlTjR2wJ6O
=GGzt
-----END PGP SIGNATURE-----

[Jeremias E.]

Am Donnerstag, 24. September 2015 11:13:22 UTC+2 schrieb Axon:

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Jeremias E.:
> Hello,
>
> kramdown also supports fenced code blocks with ~~~ three tilde
> instead of three ```  (see:
> http://kramdown.gettalong.org/syntax.html#code-blocks) This would
> be an easy change.
>

I replaced the github flavored code blocks by kramdown's three tilde fenced code blocks.
I tested a lot and it should work with the current qubes-doc settings.

I created a pull request.
 

[Jeremias E.]

Hello,

do you want to merge the following:
 

I replaced the github flavored code blocks by kramdown's three tilde fenced code blocks.
I tested a lot and it should work with the current qubes-doc settings.

I created a pull request.

I keep this pull request in sync for two weeks now.

Best regards
  J. Eppler

[Marek Marczykowski-Górecki]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Merged. I hope I didn't break anything (and didn't introduced too many
conflicts with ongoing work on other issues, like URL scheme)...

Thanks!

- --
Best Regards,
Marek Marczykowski-Górecki
Invisible Things Lab
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBCAAGBQJWFcATAAoJENuP0xzK19cs1AMH/1w1/QPkP5yLe3Jg6tipu+Sh
jJjBte75xqRyAY27qtAtVd70lRf5bz8YXyXYB7DXLQmB7Z0ULhkvDnFskTNNFsoL
kQEWcXqe3OxFcQ2lrQ3IYd6qCc0aWgt1G+eVnCq1KQj4gK9MGDhgzPQKY6DIgKcT
TwfgJdXVPOSQiC9CQoM405sJP2C8FvpUi1aSgfN7jPwhRcTdRbkTjCIqeo02RadA
nQO0IAmT4tp3garTzAZhiiDzbXcYUpuddhZ9YH3Qtcp+WsKgiITjv96X5L/y12Y8
gP/OEB4tjPWDsoGX6VErjMm1TgO7MkPeEqqkcJ0g0nOJAegTS2gYIfGBVnckYsQ=
=jwLT
-----END PGP SIGNATURE-----