Rewrite the guides to Markdown #450
Conversation
linkify extra was added to the `myst-parser` dependency and `uv.lock` was updated accordingly.
Please note that the MyST syntax of several elements (e.g., admonitions, images, cross-references etc.) is different from the syntax used by MkDocs.
|
Dělím review po kousíčkách, kdybyste se k tomu dostal někdo jiný tak začněte odspodu a dejte vědět :) |
| "dollarmath", | ||
| "deflist", | ||
| "linkify", |
There was a problem hiding this comment.
We don't use math.
Linkify makes some questionable choices; let's enable it separately if needed.
| "dollarmath", | |
| "deflist", | |
| "linkify", | |
| "deflist", |
There was a problem hiding this comment.
@encukou I added linkify because it could make things easier for contributors with less experience, since GitHub offers a similar behaviour. Maybe setting myst_linkify_fuzzy_links=False (docs) would be the middle ground between making things easier and not making it annoying?
https://www.python.org -> would be converted to a link
www.python.org -> not converted (GH converts it)
| "click==8.2.1", | ||
| "jinja2==3.1.6", | ||
| "myst-parser==4.0.1", | ||
| "myst-parser[linkify]==4.0.1", |
|
Vypadá to skvěle, našel jsem pár drobností (sorry za switching jazyků, nepsal jsem to najednou :) |
Co-authored-by: Petr Viktorin <[email protected]>
|
Já jsem pro |
There was a problem hiding this comment.
Tak jsem na to mrknul! Spousta práce! Super!
- V hlavní větvi proběhly nějaké změny, tak je potřeba udělat rebase
- S tím linkify bych to viděl aspoň na to fuzzy false nastavení.
Když to bude vyřešené, mergnul bych to! Tyto věci bych řešil spíš někdy v budoucnu:
- Vidím, že texty jsou prošpikované dt/dd (definition list), čemuž bych se dnes už asi vyhnul, ale nemusíme to řešit v rámci tohoto PR. Trochu souvisí i s #121
- Jsou tam mrtvé návody, ale nemusíme to řešit v rámci tohoto PR, založil jsem separé issues.
|
|
||
| # Jak pořádat Python sraz (Pyvo) | ||
|
|
||
| % Protože Sphinx umožňuje odkazování napříč dokumenty, hodí se mít názvy odkazů unikátní. Z toho důvodu všechny odkazy v této příručce začínají 'srazy-'. |
There was a problem hiding this comment.
Myslím, že by mohlo být pro většinu lidí viditelnější a srozumitelnější, kdyby to byl obyč HTML komentář:
| % Protože Sphinx umožňuje odkazování napříč dokumenty, hodí se mít názvy odkazů unikátní. Z toho důvodu všechny odkazy v této příručce začínají 'srazy-'. | |
| <!-- | |
| Protože Sphinx umožňuje odkazování napříč dokumenty, hodí se mít názvy odkazů unikátní. Z toho důvodu všechny odkazy v této příručce začínají 'srazy-'. | |
| --> |
| @@ -0,0 +1,27 @@ | |||
| # Jak učit Python na střední škole | |||
| @@ -1,8 +1,8 @@ | |||
| Jak v ČR pořádat Django Girls | |||
|
|
||
| ### Přicházím na místo konání | ||
|
|
||
| **Příchod** |
There was a problem hiding this comment.
Maybe we could have these as regular H4s?
There was a problem hiding this comment.
Asi to nemusíme řešit teď, vidím, že ve spoustě těch návodů by se dalo předělávat a opravovat markup. Nemíchejme to teď s překlopením syntaxe.
| ## How to ask / vote on questions | ||
|
|
||
| 1) Go to `www.sli.do` and use ``#pyconcz`` code to join the event | ||
| 1) Go to *www.sli.do* and use ``#pyconcz`` code to join the event |
There was a problem hiding this comment.
Ve skutečnosti dnes už https://www.slido.com/
| ## How to moderate | ||
|
|
||
| 1) Go to `www.sli.do` and log in (ask for credentials if you don't have them, | ||
| 1) Go to *www.sli.do* and log in (ask for credentials if you don't have them, |
In the spirit of #434, I rewrote all the pages under "guides" to markdown. If this gets accepted, I can continue to rewrite the rest of the docs.
However, if we end up using MkDocs, please note that MyST (the markdown parser for Sphinx) use a different syntax than MkDocs for several elements:
{slack}`<...>`,{twitter}`<...>`,{gh-repo}`<...>`- those will need to be re-implemented as plugins, or just rewritten as plain links (might be an better option).There might be more differences, but these are the ones I run into. Additonal work will be needed to get it working properly under MkDocs.