PyPI - mkdocs - Versions diffs - 2.0.dev0__tar.gz → 2.0.dev2__tar.gz - Mend

mkdocs 2.0.dev0tar.gz → 2.0.dev2tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (33) hide show

{mkdocs-2.0.dev0 → mkdocs-2.0.dev2}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: mkdocs
-Version: 2.0.dev0
+Version: 2.0.dev2
 Summary: HTTP, for Python.
 Author-email: Kim Christie <noreply@lovelydinosaur.com>
 Classifier: Development Status :: 4 - Beta
@@ -18,4 +18,3 @@ Requires-Dist: click
 Requires-Dist: httpx>=1.0.dev5
 Requires-Dist: jinja2
 Requires-Dist: markdown
-Requires-Dist: pygments

mkdocs-2.0.dev2/docs/README.md ADDED Viewed

@@ -0,0 +1,54 @@
+<style>
+h2 { margin-top: 50px}
+</style>
+# MkDocs
+MkDocs is a smart, simple, website design tool.
+Getting started is easy...
+```shell
+$ pip install mkdocs --pre
+```
+*This will install the version 2.0 pre-release.*
+## Getting started
+1. Create a `docs/README.md` page.
+2. Run `mkdocs serve` to view your documentation in a browser.
+3. Run `mkdocs build` to build a static website ready to host.
+## Writing your docs
+1. Create additional markdown pages.
+2. Use relative interlinking between pages.
+3. Include images and use relative interlinking from pages.
+*MkDocs supports [GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) for page authoring.*
+## Styling your docs
+1. Create a `templates/base.html` to customise the styling.
+2. Include css and javascript to serve static files.
+*MkDocs uses [Jinja templating](https://jinja.palletsprojects.com/en/stable/templates/) for HTML rendering.*
+A starting point can be as simple as...
+```html
+<html>
+    <head>
+        <meta charset="utf-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <title>{{ page.title }}</title>
+        <link rel="stylesheet" href="{{ '/css/default.css' | url }}">
+    </head>
+    <body>
+        <main>
+            {{ page.html }}
+        </main>
+    </body>
+</html>
+```

{mkdocs-2.0.dev0 → mkdocs-2.0.dev2}/pyproject.toml RENAMED Viewed

@@ -26,7 +26,6 @@ dependencies = [
     "click",
     "jinja2",
     "markdown",
-    "pygments",
 ]
 dynamic = ["version"]

mkdocs-2.0.dev2/src/mkdocs/__version__.py ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ __title__ = "mkdocs"
2	+ __version__ = "2.0.dev2"

{mkdocs-2.0.dev0 → mkdocs-2.0.dev2}/src/mkdocs/mkdocs.py RENAMED Viewed

@@ -52,6 +52,14 @@ class Page:
         self.url = str(url).removesuffix('index.html')
+class PageAsHTML:
+    def __init__(self, page, title, html):
+        self.path = page.path
+        self.url = page.url
+        self.title = title
+        self.html = html
 class Static:
     def __init__(self, path):
         self.path = path
@@ -125,7 +133,7 @@ class MkDocs:
         dir = pathlib.Path(input_dir)
         loader = jinja2.ChoiceLoader([
             jinja2.FileSystemLoader(dir.joinpath("templates")),
-            jinja2.PackageLoader('mkdocs', 'default'),
+            jinja2.PackageLoader('mkdocs', 'theme'),
         ])
         env = jinja2.Environment(loader=loader, auto_reload=True)
         env.filters['url'] = url
@@ -134,7 +142,6 @@ class MkDocs:
     def init_md(self) -> markdown.Markdown:
         return markdown.Markdown(
             extensions=[
-                'codehilite',
                 'fenced_code',
                 'footnotes',
                 'tables',
@@ -174,7 +181,9 @@ class MkDocs:
             with self.set_context(page):
                 text = input_path.read_text()
                 html = self.md.reset().convert(text)
-                output = self.base.render(page=page, html=html)
+                title = self.md.toc_tokens[0]['name'] if self.md.toc_tokens else ''
+                rendered_page = PageAsHTML(page=page, title=title, html=html)
+                output = self.base.render(page=rendered_page)
             output_path.parent.mkdir(parents=True, exist_ok=True)
             output_path.write_text(output)
@@ -205,7 +214,9 @@ class MkDocs:
                 with self.set_context(resource):
                     text = input_path.read_text()
                     html = self.md.reset().convert(text)
-                    output = self.base.render(page=resource, html=html)
+                    title = self.md.toc_tokens[0]['name'] if self.md.toc_tokens else ''
+                    rendered_page = PageAsHTML(page=page, title=title, html=html)
+                    output = self.base.render(page=rendered_page)
                 return httpx.Response(200, content=httpx.HTML(output))
             elif isinstance(resource, Static):
                 input_path = input_dir.joinpath(resource.path)

mkdocs-2.0.dev2/src/mkdocs/theme/base.html ADDED Viewed

@@ -0,0 +1,173 @@
+<html>
+    <head>
+        <meta charset="utf-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <title>{{ page.title }}</title>
+        <link rel="icon" href="data:image/svg+xml,&lt;svg xmlns=&quot;http://www.w3.org/2000/svg&quot; viewBox=&quot;0 0 100 100&quot;&gt;&lt;text y=&quot;.9em&quot; font-size=&quot;90&quot;&gt;📘&lt;/text&gt;&lt;/svg&gt;">
+        <style>
+/* Color scheme */
+:root {
+    --fg-color: #f0f6fc;
+    --muted-fg-color: #9198a1;
+    --neutral-color: #3d444d;
+    --bg-color: #151b23;
+    --link-color: #4493f8;
+    --code-bg-color: #0d1117;
+    --accent-note: #0969da;
+    --accent-tip: #1a7f37;
+    --accent-important:#8250df;
+    --accent-warning: #9a6700;
+    --accent-caution: #d1242f;
+}
+/* Basic reset */
+* {
+    margin: 0;
+    padding: 0;
+    box-sizing: border-box;
+    font-weight: 300;
+}
+/* Layout... */
+main {
+    margin-left: 20%;
+    width: 60%;
+    padding: 1rem;
+}
+@media (max-width: 1000px) {
+    main {
+        padding: 1.5rem 1rem;
+        width: 75%;
+        margin-left: 25%;
+    }
+}
+@media (max-width: 800px) {
+    main {
+        padding: 1.5rem 1rem;
+        width: 100%;
+        margin-left: 0;
+    }
+}
+/* Typography & spacing */
+html {
+    scroll-behavior: smooth;
+}
+body {
+    line-height: 1.6;
+    color: var(--fg-color);
+    background-color: var(--bg-color);
+    font-family: Helvetica, sans-serif;
+}
+h1, h2, h3, h4, h5 {
+    margin-top: 1.5rem;
+    margin-bottom: 1.5rem;
+    line-height: 1.3;
+}
+h1 {
+    border-bottom: 1px solid var(--neutral-color);
+}
+h2 {
+    border-bottom: 1px solid var(--neutral-color);
+}
+p {
+    margin: 1rem 0;
+}
+strong {
+    font-weight: 600;
+}
+ul, ol {
+    padding-left: 2rem;
+}
+li {
+    margin: 0.5rem 0;
+}
+hr {
+    margin-top: 1rem;
+    margin-bottom: 1rem;
+    border: none;
+    border-top: 4px solid;
+    color: var(--neutral-color);
+}
+blockquote {
+    border-left: 0.25rem solid var(--neutral-color);
+    padding: 0 1rem;
+    color: var(--muted-fg-color);
+}
+pre {
+    padding: 1rem;
+    overflow-x: scroll;
+    background-color:  var(--code-bg-color);
+}
+code {
+    padding: 0 5px;
+    background-color: var(--code-bg-color);
+}
+pre code {
+    padding: 0;
+}
+img {
+    max-width: 100%
+}
+a {
+    color: var(--link-color);
+    text-decoration: none;
+}
+a:hover {
+    text-decoration: underline;
+}
+/* Tables */
+table {
+    border-collapse: collapse;
+}
+th, td {
+    padding: 6px 13px;
+    border: 1px solid var(--neutral-color);
+}
+/* Header anchor links */
+a.toclink {
+    color: inherit;
+    text-decoration: none;
+}
+a.toclink:hover::after {
+    content: "#";
+    margin: 0 0.8rem;
+    color: var(--neutral-color);
+}
+        </style>
+    </head>
+    <body>
+        <main>
+            {{ page.html }}
+        </main>
+    </body>
+</html>

{mkdocs-2.0.dev0 → mkdocs-2.0.dev2}/uv.lock RENAMED Viewed

@@ -137,7 +137,6 @@ dependencies = [
     { name = "httpx" },
     { name = "jinja2" },
     { name = "markdown" },
-    { name = "pygments" },
 ]
 [package.metadata]
@@ -146,16 +145,6 @@ requires-dist = [
     { name = "httpx", specifier = ">=1.0.dev5" },
     { name = "jinja2" },
     { name = "markdown" },
-    { name = "pygments" },
-]
-[[package]]
-name = "pygments"
-version = "2.21.0"
-source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/49/2e/ced460408999b33da6b31b0021b0f37d329e202d4169aeb164493778f25b/pygments-2.21.0.tar.gz", hash = "sha256:610ca751c9bc2492b38eb9a38a7fbc93edbbb2d7182edaf34e66ae493dee5c8c", size = 5005329, upload-time = "2026-08-17T08:02:48.824Z" }
-wheels = [
-    { url = "https://files.pythonhosted.org/packages/71/46/17f022dd3e953bf20a04a028a21ec746d942f8d2af30fa0f124fa0e6a684/pygments-2.21.0-py3-none-any.whl", hash = "sha256:2363c69b61c4a97c838da3b130dcd6468f4848992b21a82f2a63ec34377137d9", size = 1250147, upload-time = "2026-08-17T08:02:44.912Z" },
 ]
 [[package]]

mkdocs-2.0.dev0/README.md DELETED Viewed

@@ -1,74 +0,0 @@
-# MkDocs
-MkDocs is a smart, simple, website design tool.
-![MkDocs](docs/img/mkdocs.png)
-<br/>
-## Installation
-Install the `mkdocs` command line tool...
-```shell
-$ pip install git+https://github.com/encode/mkdocs.git
-```
-*This will install the version 2.0 pre-release.*
-<br/>
-## Getting started
-1. Create a `README.md` page.
-2. Run `mkdocs serve` to view your documentation in a browser.
-3. Run `mkdocs build` to build a static website ready to host.
-*MkDocs supports [GitHub Flavored Markdown](docs/writing.md) for page authoring.*
-<br/>
-## Writing your docs
-1. Create additional markdown pages.
-2. Use [markdown interlinking](docs/navigation.md#interlinking) between pages.
-3. Create a `mkdocs.toml` file to define [the site navigation](docs/navigation.md#navigation) and other configuration.
-4. Move your markdown pages into a `docs` directory, and update the config.
-An example `mkdocs.toml`...
-```toml
-[mkdocs]
-nav = [
-    {path="README.md", title="Introduction"},
-    {path="CREDITS.md", title="Credits"},
-]
-[loaders]
-theme = "pkg://mkdocs/default"
-docs = "dir://docs"
-[context]
-title = "Documentation"
-favicon = "📘"
-```
-*Use either [`README.md` or `index.md`](docs/navigation.md#url-structure) for the homepage.*
-<br/>
-## Custom styling
-Styling adaptations can be kept simple, such as customising the colour scheme, or more comprehensive, such as creating an entirely new theme.
-1. Configure the base theme for your project.
-2. Modify [the HTML templating](docs/styling.md#templates) to customise the layout.
-3. Override or add [CSS and JavaScript](docs/styling.md#statics) static assets.
-Take a look at the [default theme](https://github.com/lovelydinosaur/mkdocs-theme) and the [kelp theme](https://github.com/lovelydinosaur/kelp-theme) for examples of getting started with theming.
-<br/>
-![Kelp](docs/img/kelp.png)
-*The MkDocs documentation, served with the Kelp theme.*

mkdocs-2.0.dev0/docs/img/kelp.png DELETED Viewed

Binary file

mkdocs-2.0.dev0/docs/img/mkdocs.png DELETED Viewed

Binary file

mkdocs-2.0.dev0/docs/index.md DELETED Viewed

@@ -1,60 +0,0 @@
-# MkDocs
-MkDocs is a smart, simple, website design tool.
-![MkDocs](img/mkdocs.png)
-## Installation
-Install the `mkdocs` command line tool...
-```shell
-$ pip install git+https://github.com/encode/mkdocs.git
-```
-*This will install the version 2.0 pre-release.*
-## Getting started
-1. Create a `README.md` page.
-2. Run `mkdocs serve` to view your documentation in a browser.
-3. Run `mkdocs build` to build a static website ready to host.
-*MkDocs supports [GitHub Flavored Markdown](writing.md) for page authoring.*
-## Writing your docs
-1. Create additional markdown pages.
-2. Use [markdown interlinking](navigation.md#interlinking) between pages.
-3. Create a `mkdocs.toml` file to define [the site navigation](navigation.md#navigation) and other configuration.
-4. Move your markdown pages into a `docs` directory, and update the config.
-An example `mkdocs.toml`...
-```toml
-[mkdocs]
-nav = [
-    {path="README.md", title="Introduction"},
-    {path="CREDITS.md", title="Credits"},
-]
-[loaders]
-theme = "pkg://mkdocs/default"
-docs = "dir://docs"
-[context]
-title = "Documentation"
-favicon = "📘"
-```
-*Use either [`README.md` or `index.md`](navigation.md#url-structure) for the homepage.*
-## Custom styling
-Styling adaptations can be kept simple, such as customising the colour scheme, or more comprehensive, such as creating an entirely new theme.
-1. Configure the base theme for your project.
-2. Modify [the HTML templating](styling.md#templates) to customise the layout.
-3. Override or add [CSS and JavaScript](styling.md#statics) static assets.
-Take a look at the [default theme](https://github.com/lovelydinosaur/mkdocs-theme) and the [kelp theme](https://github.com/lovelydinosaur/kelp-theme) for examples of getting started with theming.

mkdocs-2.0.dev0/docs/navigation.md DELETED Viewed

@@ -1,92 +0,0 @@
-# Interlinking & Navigation
-Navigation within your documentation is handled by using [document interlinking](#interlinking), and optional [site-wide navigation](#navigation).
-## Interlinking
-Use relative markdown links to allow users to navigate between documents.
-For example, a website with `README.md` and `CONTRIBUTING.md` pages, might include the following&hellip;
-```markdown
-See our [contribution documentation](CONTRIBUTING.md) for more details on getting involved.
-```
-If your site includes pages within a directory structure, the page interlinking might also include [relative paths between directories](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#relative-links).
-## Navigation
-You can include site-wide navigation by using the `mkdocs.toml` configuration.
-This is typically used by the HTML styling to include a navigation menu.
-```toml
-[mkdocs]
-nav = [
-    {title="Introduction", path="index.md"},
-    {title="Writing Markdown", path="markdown.md"},
-    {title="Site Navigation", path="navigation.md"},
-    {title="HTML Styling", path="styling.md"}
-]
-```
-This allows the theme to display navigation controls, as well as including `← previous` and `next →` links.
-The navigation configuration can also include nested elements.
-```toml
-[mkdocs]
-nav = [
-    {title="Introduction", path="index.md"},
-    {title="Tutorial", children=[
-        {title="Creating a project", path="tutorial/new.md"},
-        {title="Adding pages", path="tutorial/pages.md"},
-        {title="Publishing your work", path="tutorial/publish.md"},
-    ]},
-    {title="Topics", children=[
-        {title="Page layouts", path="topics/layouts.md"},
-        {title="Typography", path="topics/typography.md"},
-        {title="Color schemes", path="topics/schemes.md"},
-    ]}
-]
-```
-## URL Structure
-Ensuring your website has a clean, meaningful URL structure is important for navigation.
-* Markdown pages are lowercased.
-* The file extension is not included in the URL.
-* Use either `index.md` or `README.md` for root URLs.
-**Examples**
-A standard documentation site...
-| **Markdown Page** | **HTML output**         | **URL**        |
-|-------------------|-------------------------|----------------|
-| `index.md`        | `index.html`            | `/`            |
-| `markdown.md`     | `markdown/index.html`   | `/markdown/`   |
-| `navigation.md`   | `navigation/index.html` | `/navigation/` |
-| `styling.md`      | `styling/index.html`    | `/styling/`    |
-<br/>
-Uppercase filenames and GitHub style document paths...
-| **Markdown Page** | **HTML output**          | **URL**        |
-|-------------------|--------------------------|----------------|
-| `README.md`       | `index.html`             | `/`            |
-| `ABOUT.md`        | `about.html`             | `/about/`      |
-<br/>
-Documentation structure including subdirectories...
-| **Markdown Page**        | **HTML output**                  | **URL**                 |
-|--------------------------|----------------------------------|-------------------------|
-| `index.md`               | `index.html`                     | `/`                     |
-| `tutorial/quickstart.md` | `tutorial/quickstart/index.html` | `/tutorial/quickstart/` |
-| `tutorial/next-steps.md` | `tutorial/next-steps/index.html` | `/tutorial/next-steps/` |
-<br/>

mkdocs-2.0.dev0/docs/styling.md DELETED Viewed

@@ -1,153 +0,0 @@
-# Themes & Styling
-Styling is handled with HTML templating and regular web design.
-The build is made up of various web resources...
-* [Templates](#templates) - *The HTML templates used to render documentation pages.*
-* [Pages](#pages) - *The markdown files comprising the documentation.*
-* [Statics](#statics) - *Media assests including images, CSS, and JavaScript.*
-Resources are loaded either from a *theme* or from the *project documentation*. The theme system allows minor local styling overrides, or complete site customisation.
-* [Themes](#themes) - *Theme and documentation configuration is handled in the `mkdocs.toml` file.*
-## Templates
-Anything in the `/templates/` directory is treated as a [Jinja template](https://jinja.palletsprojects.com/en/stable/templates/), and is used to render markdown pages. You can override templates locally and adapt them to make layout changes.
-The base template for rendering markdown pages is **`templates/base.html`**.
-```html
-<html>
-    <head>
-        <meta charset="utf-8">
-        <meta name="viewport" content="width=device-width, initial-scale=1.0">
-        <title>{{ nav.current.title or page.title }}{{ " - " ~ config.context.title if config.context.title }}</title>
-        <link rel="icon" href="data:image/svg+xml,&lt;svg xmlns=&quot;http://www.w3.org/2000/svg&quot; viewBox=&quot;0 0 100 100&quot;&gt;&lt;text y=&quot;.9em&quot; font-size=&quot;90&quot;&gt;{{ config.mkdocs.favicon or '📘' }}&lt;/text&gt;&lt;/svg&gt;">
-        <link rel="stylesheet" href="{{ '/css/highlightjs.min.css' | url }}">
-        <link rel="stylesheet" href="{{ '/css/highlightjs-copy.min.css' | url }}">
-        <link rel="stylesheet" href="{{ '/css/theme.css' | url }}">
-        <script src="{{ '/js/highlightjs.min.js' | url }}"></script>
-        <script src="{{ '/js/highlightjs-copy.min.js' | url }}"></script>
-        <script src="{{ '/js/theme.js' | url }}"></script>
-    </head>
-    <body>
-        <nav class="left">
-            {{ nav.html }}
-        </nav>
-        <nav class="right">
-            {{ page.toc }}
-        </nav>
-        <main>
-            {{ page.html }}
-            {% if nav.previous or nav.next %}
-            <div class="pagination">
-                {% if nav.previous %}
-                <a class="previous" href="{{ nav.previous.url }}">← {{ nav.previous.title }}</a>
-                {% endif %}
-                {% if nav.next %}
-                <a class="next" href="{{ nav.next.url }}">{{ nav.next.title }} →</a>
-                {% endif %}
-            </div>
-            {% endif %}
-        </main>
-    </body>
-</html>
-```
-The following template is included in [the default theme](https://github.com/encode/mkdocs/blob/main/src/mkdocs/theme/)...
-* `templates/base.html`- The base template used for rendering markdown pages.
-The following context is passed to the template rendering...
-*Variable*           | *Description*
----------------------|--------------------------------------
-`page`               | The markdown page.
-`page.html`          | The page contents, rendered as HTML.
-`page.text`          | The text of the page, as markdown.
-`page.path`          | The path of the source file.
-`page.url`           | The URL from which the page is served.
-`page.toc`           | The table of contents for the page, as HTML.
-`page.title`         | The first heading in the table of contents.
-`nav`                | The site navigation.
-`nav.html`           | The site navigation, rendered into HTML.
-`nav.previous`       | The previous page, as configured in the nav.
-`nav.previous.title` | The title of the previous page.
-`nav.previous.url`   | The url of the previous page.
-`nav.next`           | The next page, as configured in the nav.
-`nav.next.title`     | The title of the next page.
-`nav.next.url`       | The url of the next page.
-`config`             | The `mkdocs.toml` configuration.
-## Pages
-Any files ending with the `*.md` extension are treated as markdown pages, and rendered into HTML, then included in the base template.
-The following are treated as index pages...
-* `README.md` - Served as `/`.
-* `index.md` - Served as `/`.
-All other pages are lowercased, and served from a URL without the markdown extension...
-* `CONTRIBUTING.md` - Served as `/contributing/`.
-## Statics
-Any files that are not Markdown pages `*.md`, or templates `/templates/*`, are treated as static media and are included in the website without modification.
-This can include images, stylesheets, javascript, fonts, video and audio.
-The default theme includes the following static media...
-* [`css/theme.css`](css/theme.css)
-* [`css/highlightjs.min.css`](css/highlightjs.min.css)
-* [`css/highlightjs-copy.min.css`](css/highlightjs-copy.min.css)
-* [`js/theme.js`](js/theme.js)
-* [`js/highlightjs.min.js`](js/highlightjs.min.js)
-* [`js/highlightjs-copy.min.js`](js/highlightjs-copy.min.js)
-## Themes
-Themes can be packaged and distributed as part of a zip archive. The archive can the either be loaded remotely from a URL, or downloaded and included locally.
-Controlling how resources are loaded for the theme and documentation is handled with the `mkdocs.toml` config file.
-**Example configurations**
-*The default theme supplied by the `mkdocs` package, and the documentation served directly from the project directory. This is the default configuration...*
-```toml
-[loaders]
-theme = "pkg://mkdocs/default"
-docs = "dir://"
-```
-*The default theme as a `.zip` URL, and a local `docs` directory...*
-```toml
-[loaders]
-theme = "https://github.com/lovelydinosaur/mkdocs-theme/archive/refs/heads/main.zip"
-docs = "dir://docs"
-```
-*A theme downloaded locally, and a `docs` directory...*
-```toml
-[loaders]
-theme = "dir://theme"
-docs = "dir://docs"
-```
-*Both the theme and the documentation included in a single directory...*
-```toml
-[mkdocs]
-theme = "dir://docs"
-docs = "dir://docs"
-```
-<br/>

mkdocs-2.0.dev0/docs/writing.md DELETED Viewed

@@ -1,241 +0,0 @@
-# Writing Markdown
-MkDocs supports regular Markdown syntax with some Github Flavored Markdown extensions.
-For other references on writing in Markdown, see the [GitHub documentation](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax), the [Markdown Guide](https://www.markdownguide.org/), or the author's [original documentation](https://daringfireball.net/projects/markdown/).
-The rest of this page provides a reference guide to the supported markdown syntax.
-## Headings
-```markdown
-# H1
-## H2
-### H3
-#### H4
-##### H5
-```
-<h1>H1</h1>
-<h2 style="margin-top: 1.5rem">H2</h2>
-<h3>H3</h3>
-<h4>H4</h4>
-<h5>H5</h5>
-## Formatting
-```markdown
-* **Bold text**
-* *Italic text*
-* ~~Strikethrough~~
-* <ins>Underlined</ins>
-* e <sup>i π</sup> = -1
-* H<sub>2</sub>O
-```
-<span></span>
-* **Bold text**
-* *Italic text*
-* ~~Strikethrough~~
-* <ins>Underlined</ins>
-* e <sup>i π</sup> = -1
-* H<sub>2</sub>O
-## Lists
-```markdown
-- First item
-- Second item
-- Third item
-```
-<span></span>
-- First item
-- Second item
-- Third item
-## Ordered Lists
-```markdown
-1. First item
-2. Second item
-3. Third item
-```
-<span></span>
-1. First item
-2. Second item
-3. Third item
-## Links
-```markdown
-See [wikipedia](https://www.wikipedia.org/).
-```
-See [wikipedia](https://www.wikipedia.org/).
-## Section links
-```markdown
-See the [Links](#links) section.
-```
-See the [Links](#links) section.
-## Relative Links
-```markdown
-Back to the [Homepage](index.md).
-```
-Back to the [Homepage](index.md).
-## Images
-```markdown
-![coder cat](img/codercat.png)
-```
-![coder cat](img/codercat.png)
-## Inline Code
-```markdown
-`&mdash;`
-```
-`&mdash;`
-## Code Block
-<pre><code class="language-markdown hljs">```json
-{
-  "firstName": "John",
-  "lastName": "Smith",
-  "age": 25
-}
-```</code></pre>
-<span></span>
-```json
-{
-  "firstName": "John",
-  "lastName": "Smith",
-  "age": 25
-}
-```
-## Horizontal Rule
-```markdown
----
-```
----
-<br/>
-## Table
-```markdown
-| Syntax    | Description |
-| --------- | ----------- |
-| Header    | Title       |
-| Paragraph | Text        |
-```
-<span></span>
-| Syntax    | Description |
-| --------- | ----------- |
-| Header    | Title       |
-| Paragraph | Text        |
-## Footnotes
-```markdown
-Here's a sentence with a footnote. [^1]
-[^1]: This is the footnote from earlier.
-```
-Here's a sentence with a footnote. [^1]
-[^1]: This is the footnote from earlier.
-## Blockquote
-```markdown
-> Rumors of my death have been greatly exaggerated.
-```
-> Rumors of my death have been greatly exaggerated.
-## Alerts
-```markdown
-> [!NOTE]
-> Useful information that users should know, even when skimming content.
-```
-> [!NOTE]
-> Useful information that users should know, even when skimming content.
-```markdown
-> [!TIP]
-> Helpful advice for doing things better or more easily.
-```
-> [!TIP]
-> Helpful advice for doing things better or more easily.
-```markdown
-> [!IMPORTANT]
-> Key information users need to know to achieve their goal.
-```
-> [!IMPORTANT]
-> Key information users need to know to achieve their goal.
-```markdown
-> [!WARNING]
-> Urgent info that needs immediate user attention to avoid problems.
-```
-> [!WARNING]
-> Urgent info that needs immediate user attention to avoid problems.
-```markdown
-> [!CAUTION]
-> Advises about risks or negative outcomes of certain actions.
-```
-> [!CAUTION]
-> Advises about risks or negative outcomes of certain actions.
-## Emoji
-```markdown
-:+1: This PR looks great :heart:
-```
-:+1: This PR looks great :heart:
-## Task List
-```markdown
-- [x] Write the press release
-- [ ] Update the website
-- [ ] Contact the media
-```
-<span></span>
-- [x] Write the press release
-- [ ] Update the website
-- [ ] Contact the media