PyPI - mkdocs - Versions diffs - 1.6.1__tar.gz → 2.0.dev1__tar.gz - Mend

mkdocs 1.6.1tar.gz → 2.0.dev1tar.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 (287) hide show

mkdocs-2.0.dev1/.github/workflows/docs.yml ADDED Viewed

@@ -0,0 +1,28 @@
+name: Documentation
+on:
+  push:
+    branches:
+        - main
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/configure-pages@v5
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: pip install -r requirements.txt
+      - run: mkdocs build
+      - uses: actions/upload-pages-artifact@v4
+        with:
+          path: site
+      - uses: actions/deploy-pages@v4
+        id: deployment

mkdocs-2.0.dev1/.github/workflows/test-suite.yml ADDED Viewed

@@ -0,0 +1,36 @@
+---
+name: Test Suite
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+jobs:
+  tests:
+    name: "Python ${{ matrix.python-version }}"
+    runs-on: "ubuntu-latest"
+    strategy:
+      matrix:
+        python-version: ["3.10"]
+    steps:
+      - uses: "actions/checkout@v4"
+      - uses: "actions/setup-python@v6"
+        with:
+          python-version: "${{ matrix.python-version }}"
+      - name: "Install dependencies"
+        run: "scripts/install"
+      - name: "Run tests"
+        run: "scripts/test"
+      # - name: "Run linting checks"
+      #   run: "scripts/check"
+      # - name: "Build package & docs"
+      #   run: "scripts/build"
+      # - name: "Run tests"
+      #   run: "scripts/test"
+      # - name: "Enforce coverage"
+      #   run: "scripts/coverage"

mkdocs-2.0.dev1/.gitignore ADDED Viewed

@@ -0,0 +1,4 @@
+*.pyc
+venv/
+dist/
+site/

mkdocs-2.0.dev1/PKG-INFO ADDED Viewed

@@ -0,0 +1,20 @@
+Metadata-Version: 2.5
+Name: mkdocs
+Version: 2.0.dev1
+Summary: HTTP, for Python.
+Author-email: Kim Christie <noreply@lovelydinosaur.com>
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Requires-Python: >=3.10
+Requires-Dist: click
+Requires-Dist: httpx>=1.0.dev5
+Requires-Dist: jinja2
+Requires-Dist: markdown

mkdocs-2.0.dev1/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.dev1/docs/img/codercat.png ADDED Viewed

Binary file

mkdocs-2.0.dev1/mkdocs.toml ADDED Viewed

@@ -0,0 +1,15 @@
+[mkdocs]
+nav = [
+    {title="Introduction", path="index.md"},
+    {title="Writing Markdown", path="writing.md"},
+    {title="Interlinking & Navigation", path="navigation.md"},
+    {title="Themes & Styling", path="styling.md"}
+]
+[loaders]
+theme = "pkg://mkdocs/default"
+docs = "dir://docs"
+[context]
+title = "MkDocs"
+favicon = "📘"

mkdocs-2.0.dev1/pyproject.toml ADDED Viewed

@@ -0,0 +1,36 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+[project]
+name = "mkdocs"
+description = "HTTP, for Python."
+requires-python = ">=3.10"
+authors = [
+    { name = "Kim Christie", email = "noreply@lovelydinosaur.com" },
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Internet :: WWW/HTTP",
+]
+dependencies = [
+    "httpx>=1.0.dev5",
+    "click",
+    "jinja2",
+    "markdown",
+]
+dynamic = ["version"]
+[tool.hatch.version]
+path = "src/mkdocs/__version__.py"
+[project.scripts]
+mkdocs = "mkdocs:cli"

mkdocs-2.0.dev1/requirements.txt ADDED Viewed

@@ -0,0 +1,3 @@
+-e .
+pytest

mkdocs-2.0.dev1/scripts/install ADDED Viewed

@@ -0,0 +1,19 @@
+#!/bin/sh -e
+# Use the Python executable provided from the `-p` option, or a default.
+[ "$1" = "-p" ] && PYTHON=$2 || PYTHON="python3"
+REQUIREMENTS="requirements.txt"
+VENV="venv"
+set -x
+if [ -z "$GITHUB_ACTIONS" ]; then
+    "$PYTHON" -m venv "$VENV"
+    PIP="$VENV/bin/pip"
+else
+    PIP="pip"
+fi
+"$PIP" install -U pip
+"$PIP" install -r "$REQUIREMENTS"

mkdocs-2.0.dev1/scripts/test ADDED Viewed

@@ -0,0 +1,10 @@
+#!/bin/sh -e
+export PREFIX=""
+if [ -d 'venv' ] ; then
+    export PREFIX="venv/bin/"
+fi
+set -x
+${PREFIX}pytest "$@"

mkdocs-2.0.dev1/src/mkdocs/__init__.py ADDED Viewed

@@ -0,0 +1,15 @@
+from .__version__ import __title__, __version__
+from .mkdocs import get_current_page, get_site_index, Page, Static, SiteIndex, MkDocs, cli
+__all__ = [
+    '__title__',
+    '__version__',
+    'get_current_page',
+    'get_site_index',
+    'Page',
+    'Static',
+    'SiteIndex',
+    'MkDocs',
+    'cli',
+]

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

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

mkdocs-2.0.dev1/src/mkdocs/default/base.html ADDED Viewed

@@ -0,0 +1,17 @@
+<html>
+    <head>
+        <meta charset="utf-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <title>...</title>
+        {% with favicon='📘' %}{% include 'favicon.html' %}{% endwith %}
+        <style>
+            {% include 'style.css' %}
+            {% include 'highlight.css' %}
+        </style>
+    </head>
+    <body>
+        <main>
+            {{ html }}
+        </main>
+    </body>
+</html>

mkdocs-2.0.dev1/src/mkdocs/default/favicon.html ADDED Viewed

	@@ -0,0 +1 @@
1	+ <link rel="icon" href="data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100"><text y=".9em" font-size="90">{{ favicon }}</text></svg>">

mkdocs-2.0.dev1/src/mkdocs/default/highlight.css ADDED Viewed

@@ -0,0 +1,86 @@
+pre { line-height: 125%; }
+td.linenos .normal { color: #6e7681; background-color: #0d1117; padding-left: 5px; padding-right: 5px; }
+span.linenos { color: #6e7681; background-color: #0d1117; padding-left: 5px; padding-right: 5px; }
+td.linenos .special { color: #e6edf3; background-color: #6e7681; padding-left: 5px; padding-right: 5px; }
+span.linenos.special { color: #e6edf3; background-color: #6e7681; padding-left: 5px; padding-right: 5px; }
+.codehilite .hll { background-color: #6e7681 }
+.codehilite { background: #0d1117; color: #E6EDF3 }
+.codehilite .c { color: #8B949E; font-style: italic } /* Comment */
+.codehilite .err { color: #F85149 } /* Error */
+.codehilite .esc { color: #E6EDF3 } /* Escape */
+.codehilite .g { color: #E6EDF3 } /* Generic */
+.codehilite .k { color: #FF7B72 } /* Keyword */
+.codehilite .l { color: #A5D6FF } /* Literal */
+.codehilite .n { color: #E6EDF3 } /* Name */
+.codehilite .o { color: #FF7B72; font-weight: bold } /* Operator */
+.codehilite .x { color: #E6EDF3 } /* Other */
+.codehilite .p { color: #E6EDF3 } /* Punctuation */
+.codehilite .ch { color: #8B949E; font-style: italic } /* Comment.Hashbang */
+.codehilite .cm { color: #8B949E; font-style: italic } /* Comment.Multiline */
+.codehilite .cp { color: #8B949E; font-weight: bold; font-style: italic } /* Comment.Preproc */
+.codehilite .cpf { color: #8B949E; font-style: italic } /* Comment.PreprocFile */
+.codehilite .c1 { color: #8B949E; font-style: italic } /* Comment.Single */
+.codehilite .cs { color: #8B949E; font-weight: bold; font-style: italic } /* Comment.Special */
+.codehilite .gd { color: #FFA198; background-color: #490202 } /* Generic.Deleted */
+.codehilite .ge { color: #E6EDF3; font-style: italic } /* Generic.Emph */
+.codehilite .ges { color: #E6EDF3; font-weight: bold; font-style: italic } /* Generic.EmphStrong */
+.codehilite .gr { color: #FFA198 } /* Generic.Error */
+.codehilite .gh { color: #79C0FF; font-weight: bold } /* Generic.Heading */
+.codehilite .gi { color: #56D364; background-color: #0F5323 } /* Generic.Inserted */
+.codehilite .go { color: #8B949E } /* Generic.Output */
+.codehilite .gp { color: #8B949E } /* Generic.Prompt */
+.codehilite .gs { color: #E6EDF3; font-weight: bold } /* Generic.Strong */
+.codehilite .gu { color: #79C0FF } /* Generic.Subheading */
+.codehilite .gt { color: #FF7B72 } /* Generic.Traceback */
+.codehilite .g-Underline { color: #E6EDF3; text-decoration: underline } /* Generic.Underline */
+.codehilite .kc { color: #79C0FF } /* Keyword.Constant */
+.codehilite .kd { color: #FF7B72 } /* Keyword.Declaration */
+.codehilite .kn { color: #FF7B72 } /* Keyword.Namespace */
+.codehilite .kp { color: #79C0FF } /* Keyword.Pseudo */
+.codehilite .kr { color: #FF7B72 } /* Keyword.Reserved */
+.codehilite .kt { color: #FF7B72 } /* Keyword.Type */
+.codehilite .ld { color: #79C0FF } /* Literal.Date */
+.codehilite .m { color: #A5D6FF } /* Literal.Number */
+.codehilite .s { color: #A5D6FF } /* Literal.String */
+.codehilite .na { color: #E6EDF3 } /* Name.Attribute */
+.codehilite .nb { color: #E6EDF3 } /* Name.Builtin */
+.codehilite .nc { color: #F0883E; font-weight: bold } /* Name.Class */
+.codehilite .no { color: #79C0FF; font-weight: bold } /* Name.Constant */
+.codehilite .nd { color: #D2A8FF; font-weight: bold } /* Name.Decorator */
+.codehilite .ni { color: #FFA657 } /* Name.Entity */
+.codehilite .ne { color: #F0883E; font-weight: bold } /* Name.Exception */
+.codehilite .nf { color: #D2A8FF; font-weight: bold } /* Name.Function */
+.codehilite .nl { color: #79C0FF; font-weight: bold } /* Name.Label */
+.codehilite .nn { color: #FF7B72 } /* Name.Namespace */
+.codehilite .nx { color: #E6EDF3 } /* Name.Other */
+.codehilite .py { color: #79C0FF } /* Name.Property */
+.codehilite .nt { color: #7EE787 } /* Name.Tag */
+.codehilite .nv { color: #79C0FF } /* Name.Variable */
+.codehilite .ow { color: #FF7B72; font-weight: bold } /* Operator.Word */
+.codehilite .pm { color: #E6EDF3 } /* Punctuation.Marker */
+.codehilite .w { color: #6E7681 } /* Text.Whitespace */
+.codehilite .mb { color: #A5D6FF } /* Literal.Number.Bin */
+.codehilite .mf { color: #A5D6FF } /* Literal.Number.Float */
+.codehilite .mh { color: #A5D6FF } /* Literal.Number.Hex */
+.codehilite .mi { color: #A5D6FF } /* Literal.Number.Integer */
+.codehilite .mo { color: #A5D6FF } /* Literal.Number.Oct */
+.codehilite .sa { color: #79C0FF } /* Literal.String.Affix */
+.codehilite .sb { color: #A5D6FF } /* Literal.String.Backtick */
+.codehilite .sc { color: #A5D6FF } /* Literal.String.Char */
+.codehilite .dl { color: #79C0FF } /* Literal.String.Delimiter */
+.codehilite .sd { color: #A5D6FF } /* Literal.String.Doc */
+.codehilite .s2 { color: #A5D6FF } /* Literal.String.Double */
+.codehilite .se { color: #79C0FF } /* Literal.String.Escape */
+.codehilite .sh { color: #79C0FF } /* Literal.String.Heredoc */
+.codehilite .si { color: #A5D6FF } /* Literal.String.Interpol */
+.codehilite .sx { color: #A5D6FF } /* Literal.String.Other */
+.codehilite .sr { color: #79C0FF } /* Literal.String.Regex */
+.codehilite .s1 { color: #A5D6FF } /* Literal.String.Single */
+.codehilite .ss { color: #A5D6FF } /* Literal.String.Symbol */
+.codehilite .bp { color: #E6EDF3 } /* Name.Builtin.Pseudo */
+.codehilite .fm { color: #D2A8FF; font-weight: bold } /* Name.Function.Magic */
+.codehilite .vc { color: #79C0FF } /* Name.Variable.Class */
+.codehilite .vg { color: #79C0FF } /* Name.Variable.Global */
+.codehilite .vi { color: #79C0FF } /* Name.Variable.Instance */
+.codehilite .vm { color: #79C0FF } /* Name.Variable.Magic */
+.codehilite .il { color: #A5D6FF } /* Literal.Number.Integer.Long */

mkdocs-2.0.dev1/src/mkdocs/default/style.css ADDED Viewed

@@ -0,0 +1,148 @@
+/* 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;
+}
+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);
+}

mkdocs-2.0.dev1/src/mkdocs/extensions/relative_urls.py ADDED Viewed

@@ -0,0 +1,59 @@
+import markdown
+import mkdocs
+import os
+import posixpath
+import httpx
+class URLProcessor(markdown.treeprocessors.Treeprocessor):
+    def run(self, root):
+        page = mkdocs.get_current_page()
+        site_index = mkdocs.get_site_index()
+        key = ''
+        link = ''
+        for el in root.iter():
+            # We want to rewrite image and links.
+            if el.tag == 'a':
+                key = 'href'
+                link = el.get(key)
+            elif el.tag == 'img':
+                key = 'src'
+                link = el.get(key)
+            else:
+                key = ''
+                link = ''
+            if link:
+                el.set(key, link)
+                url = httpx.URL(link)
+                # We want to rewrite relative links... '/page'
+                # We don't want to rewrite external links. 'https://elsewhere.com/here'
+                # We don't want to rewrite anchor links. '#section'
+                if url.is_relative_url and url._uri_reference.path:
+                    path_from = page.path
+                    path_to = os.path.normpath(path_from.parent.joinpath(url.path))
+                    target = site_index.lookup.get(path_to)
+                    if target is None:
+                        continue  # Broken link!
+                    url_from = page.url
+                    url_to = target.url
+                    rewrite = posixpath.relpath(url_to, url_from)
+                    if url_to.endswith('/') and rewrite != '.':
+                        rewrite += '/'
+                    if url.query:
+                        rewrite += f'?{url.query}'
+                    if url.fragment:
+                        rewrite += f'#{url.fragment}'
+                    el.set(key, rewrite)
+class RelativeURLs(markdown.extensions.Extension):
+    def extendMarkdown(self, md):
+        md.treeprocessors.register(URLProcessor(md), 'relative_urls', 15)
+def makeExtension(**kwargs):
+    return RelativeURLs(**kwargs)

mkdocs-2.0.dev1/src/mkdocs/extensions/short_codes.py ADDED Viewed

@@ -0,0 +1,38 @@
+import markdown.inlinepatterns
+import xml.etree.ElementTree as etree
+codes = {
+    '+1': '👍🏼',
+    '-1': '👎',
+    'smile': '😀',
+    'heart': '❤️',
+    'tada': '🎉',
+    'fire': '🔥',
+    'rocket': '🚀',
+    'bug': '🐛',
+    'thinking': '🤔',
+    'eyes': '👀',
+    'shipit': '🚢',
+}
+class ShortCodes(markdown.inlinepatterns.InlineProcessor):
+    def handleMatch(self, m, data):
+        code = m.group(1)
+        emoji = codes.get(code)
+        if emoji is None:
+            return None, None, None
+        el = etree.Element('span')
+        el.text = emoji
+        return el, m.start(0), m.end(0)
+class ShortCodesExtension(markdown.extensions.Extension):
+    def extendMarkdown(self, md):
+        pattern = r':([a-z]{3,10}|\+1|\-1):'
+        processor = ShortCodes(pattern, md)
+        md.inlinePatterns.register(processor, 'short_codes', 175)
+def makeExtension(**kwargs):
+    return ShortCodesExtension(**kwargs)

mkdocs-2.0.dev1/src/mkdocs/extensions/strike_thru.py ADDED Viewed

@@ -0,0 +1,19 @@
+import markdown.inlinepatterns
+import xml.etree.ElementTree as etree
+class StrikeThru(markdown.inlinepatterns.InlineProcessor):
+    def handleMatch(self, m, data):
+        el = etree.Element('del')
+        el.text = m.group(1)
+        return el, m.start(0), m.end(0)
+class StrikeThruExtension(markdown.extensions.Extension):
+    def extendMarkdown(self, md):
+        pattern = r'~~([^~]+)~~'
+        processor = StrikeThru(pattern, md)
+        md.inlinePatterns.register(processor, 'strike_thru', 175)
+def makeExtension(**kwargs):
+    return StrikeThruExtension(**kwargs)

mkdocs 1.6.1__tar.gz → 2.0.dev1__tar.gz

mkdocs 1.6.1tar.gz → 2.0.dev1tar.gz