Static Sites with Sphinx and Markdown Transcripts
Chapter: Setup
Lecture: Adding Markdown
Login or
purchase this course
to watch this video and the rest of the course contents.
0:01
We just edited an '.rst' file and showed how the build can happen automatically and then the browser gets reload. But that was an RST file.
0:12
This course is about Markdown in this step, let's add markdown to our Sphinx site.
0:18
We'll do so by using 'MyST' a parser of markdown which works with Sphinx and doc tells to make it kind of transparent to Sphinx.
0:29
Whether you're using restructured text or markdown, I'll go ahead and do an install by switching back to my editor and of course
0:39
I need to go to requirements.txt and here I will add the name of the package and install it. That isn't enough to get Sphinx to use it.
0:53
Just because the packages installed doesn't mean that Sphinx knows it's really they're going to go
0:58
back to my configuration file. I'm gonna search for extensions. I'm going to add the MyST parser as an extension So with that in place
1:12
our site can now speak both restructured text and markdown, which we will do in next step.