You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+52-2Lines changed: 52 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -79,6 +79,17 @@ For TODO list support, also add the `sphinx-immaterial <https://github.com/jbms/
79
79
"sphinx_notion",
80
80
]
81
81
82
+
For mathematical equation support, also add the ``sphinx.ext.mathjax`` extension:
83
+
84
+
.. code-block:: python
85
+
86
+
"""Configuration for Sphinx."""
87
+
88
+
extensions = [
89
+
"sphinx.ext.mathjax",
90
+
"sphinx_notion",
91
+
]
92
+
82
93
PDF support is included by default with the sphinx-notionbuilder extension.
83
94
84
95
Supported markup
@@ -101,6 +112,7 @@ The following syntax is supported:
101
112
- Tables
102
113
- Strikethrough text
103
114
- Colored text and text styles (bold, italic, monospace)
115
+
- Mathematical equations (inline and block-level)
104
116
105
117
See a `sample document source <https://raw.githubusercontent.com/adamtheturtle/sphinx-notionbuilder/refs/heads/main/sample/index.rst>`_ and the `published Notion page <https://www.notion.so/Sphinx-Notionbuilder-Sample-2579ce7b60a48142a556d816c657eb55>`_.
106
118
@@ -117,7 +129,7 @@ Audio files can be embedded using the ``audio`` directive. Both remote URLs and
117
129
118
130
The audio will be rendered as an audio player in the generated Notion page.
119
131
120
-
Using PDFs
132
+
Using PDF
121
133
----------
122
134
123
135
PDF files can be embedded using the ``pdf-include`` directive. Both remote URLs and local file paths are supported.
@@ -202,6 +214,45 @@ TODO lists with checkboxes can be created using the ``sphinx-immaterial.task_lis
202
214
203
215
The checkboxes will be rendered as interactive TODO items in the generated Notion page, with completed tasks showing as checked and incomplete tasks as unchecked.
204
216
217
+
Using Mathematical Equations
218
+
-----------------------------
219
+
220
+
Mathematical equations can be embedded using the ``sphinx.ext.mathjax`` extension.
221
+
Both inline and block-level equations are supported:
222
+
223
+
Inline Equations
224
+
~~~~~~~~~~~~~~~~
225
+
226
+
Inline equations can be written using the ``:math:`` role:
227
+
228
+
.. code-block:: rst
229
+
230
+
This is an inline equation :math:`E = mc^2` in your text.
The equations will be rendered as proper mathematical notation in the generated Notion page, with inline equations appearing within the text flow and block equations appearing as separate equation blocks.
0 commit comments