Comments (5)
Ideally Sphinx + MyST + RTD, the same as the rest of EBP 😬
You don't actually need to run a GH action, just turn on PR runs on RTD:
https://docs.readthedocs.io/en/stable/guides/autobuild-docs-for-pull-requests.html
from mdformat.
Thanks for the input, I really don't have much experience in any of this.
Sphinx + MyST + RTD sounds great. Or if we want to keep using pre-commit try-repo ...
to run mdformat against its own docs, then maybe start with Sphinx + CommonMark and move to MyST, when we can come up with the necessary plugins for mdformat to handle MyST? I kinda like the pre-commit try-repo
in that it shows we trust the tool enough to format our own docs with it, and also makes mdformat docs showcase what the output looks like.
You don't actually need to run a GH action, just turn on PR runs on RTD:
Nice! Maybe it's possible to use a GH action to "validate" the docs though? Fail CI if docs fail building, so we know not to merge a PR unless the docs are fixed? Or does Sphinx build ever fail? I'm still a noob here 😄
from mdformat.
Sphinx + CommonMark and move to MyST
Oh MyST is already commonmark compliant. Its just add extra (optional) syntax plugins to the parser. If you don't use them, then it works exactly the same as CommonMark (we are in fact in talks with RTD to deprectate ReCommonMark in favour of MyST)
Fail CI if docs fail building
Yep this already happens with the RTD builds (you can see the check e.g. in executablebooks/markdown-it-py#58), you just need to add to the repo https://github.com/executablebooks/markdown-it-py/blob/master/.readthedocs.yml
from mdformat.
I can try to get round to making a PR for it at some point 😄
from mdformat.
Its just add extra (optional) syntax plugins to the parser.
Yeah this is what I was thinking could be problematic. But I think you are right, we don't really have to use the extra syntax and if we want to in some files, then skip mdformatting that file etc.
Yep this already happens with the RTD builds
Nice!
I can try to get round to making a PR for it at some point smile
This would be amazing!
from mdformat.
Related Issues (20)
- Consider respecting gfm checklists HOT 1
- Support for Front Matter with Markdown page metadata HOT 1
- `--wrap n` should respect tables HOT 2
- Escape "\|" not working in table cell HOT 3
- Support XGG base directory specification for user configuration resolution
- Checkboxes are escaped HOT 3
- mdformat breaks Hugo shortcodes by escaping `<` HOT 5
- markdown-it-py 3 support
- Not Working In Python 3.11? HOT 5
- Error: Could not format HOT 2
- Alt text wrapped in grave marks is deleted HOT 2
- Formatted md renders different html than original md HOT 2
- image path is falsely patched with `<>` if URL includes `()`, breaks render HOT 5
- Double slash in math formular HOT 3
- Incorrecly reformats python code HOT 1
- convert inline links to references? HOT 2
- Support json schema
- Word-wrap on sentence (punctuation) and width. HOT 1
- Inline elements in image descriptions are flattened and stripped HOT 2
- Numbers in ordererd lists are ignored when using MDRenderer/MDFormat HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from mdformat.