Markdown and Python Easy to do headings, paragraphs, lists
3
WAIT A SECOND !!!! That's not Markdown...
4
Static Websites with Sphinx and Markdown
5
Old Days
6
Single Page App (SPA)
7
Meanwhile, for docs
8
Meanwhile, for sites
9
What Does Sphinx Do?
10
Sphinx Site
11
Install Sphinx S pip install sphinx
12
Install MyST Spip install myst-parser
13
Configure Sphinx for MyST extensions - "myst parser", ...
14
index.rst - index.md
15
How It Works
16
Markdown Image ![Alt Text] static/logo.png
17
Enhanced Markdown Image image static/logo.png :alt: Python Logo
18
Basic Admonition
19
Enhanced Admonition
20
toctree With Options
21
toctree With YAML
22
Markdown Link URL [link text]
23
Markdown Linking [link text] (../path/to/doc)
24
Without Link Text 014../path/to/doc
25
Warning on Broken Link
26
Linking to a Role Targets and Cross-Referencing
27
Role & No Link Text
28
Intersphinx
29
Code Fence With Language
30
Code Fence Options
31
literal-include
32
Lots More To Cover
33
Plenty to Read
34
What's the Future?
Description:
Explore static site generation using Sphinx and Markdown in this 22-minute PyCon US talk. Learn how to leverage Sphinx, traditionally used for project documentation, for building entire websites. Discover the advantages of MyST, which brings full Markdown support to Sphinx, making it more accessible to those familiar with Markdown syntax. Compare Sphinx's features to other static site generators, including its rich linking capabilities and suitability for creating comprehensive knowledge bases. Follow along as the speaker demonstrates how to enable MyST for Markdown in Sphinx, configure the system, and utilize enhanced Markdown features like admonitions, toctree with options, and cross-referencing. Gain insights into customization options and explore the potential future developments of Sphinx for static site generation.