Some notes on reStructuredText in vscode now that reStructuredText by LeXtudio Inc. got redesigned
Posted by jpluimers on 2025/01/22
For my list archive; need to check this out because reStructuredText by LeXtudio Inc. got redesigned, deferring much of its behaviour to Esbonio.
Anyway:
- [Wayback/Archive] reStructuredText for VS Code Documentation
- [Wayback/Archive] Live Preview – reStructuredText for VS Code Documentation
- [Wayback/Archive] Prerequisites – reStructuredText for VS Code Documentation
- [Wayback/Archive] Esbonio
esbonio – (v.) to explainEsbonio is a Language Server for Sphinx documentation projects.Esbonio aids the writing process by resolving references, providing completion suggestions and highlighting errors. It ensures your local build is always up to date, allowing you to preview your changes in (almost!) real-time. The server itself can even be extended to better suit the needs of your project.The primary goal of Esbonio is to reduce the friction that comes from trying to remember the specifics of a markup language, so that you can focus on your content and not your tooling. - [Wayback/Archive] Keyboard Shortcuts – reStructuredText for VS Code Documentation
- [Wayback/Archive] Getting Started – Esbonio
- [Wayback/Archive] Live Previews – Esbonio
- [Wayback/Archive] Getting Started – Esbonio
For me, figuring that out under pressure how to get this to working was too much, so I deferred that to a later point in time and perform a reStructuredText to Markdown conversion in stead (I wasn’t using very esoteric .RST features, and since most people use Markdown anyway it made the documents even more accessible for others to extend). Links on that conversion:
- [Wayback/Archive] RST to MD | CloudConvert (didn’t work as well as I hoped for)
- [Wayback/Archive] markdown – How to convert .rst files to .md? – Stack Overflow (worked good enough)
the syntax for using pandoc is:pandoc [options] [input-file]……
pandoc -s -o about.md about.rst…
Pandoc, however, provides an extended version of Markdown which can be enabled through extensions. This might resolve some of your errors, but not others. - [Wayback/Archive] Pandoc wraps line in markdown at the wrong point · Issue #3277 · jgm/pandoc · GitHub
Both Markdown and reStructuredText are problematic for background images, so I opted to cut the conference background slide in half, put the top part above the title, and the bottom half below the final part of the presentation, as this didn’t really work well either:
- [Wayback/Archive] How to set Background Image in Html and Css Using vs code – YouTube
- [Wayback/Archive] html – css inline style – style=”background-image:url for local image – Stack Overflow
- [Wayback/Archive] CSS background-image – What is the correct usage? – Stack Overflow
- [Wayback/Archive] Adding custom HTML and CSS to GitHub README | Pragmatic Pineapple 🍍
- [Wayback/Archive] How to set Background Image in Html and Css Using vs code – YouTube
- [Wayback/Archive] GitHub Flavored Markdown doesn’t render CSS styles inside a HTML block · community · Discussion #22728 · GitHub
Oh, and for Visual Studio Code:
Queries:
- [Wayback/Archive] rst to md converter – Sök på Google
- [Wayback/Archive] pandoc rst to md line length – Google Search
- [Wayback/Archive] mixing html styles into markdown – Sök på Google
- [Wayback/Archive] html background image inline style relative path vscode – Sök på Google
- [Wayback/Archive] markdown html body styles – Google Search
- [Wayback/Archive] reStructuredText html “background” picture – Google Suche
--jeroen
The Wiert Corner - irregular stream of stuff 
Leave a comment