PyPI - mkdocs - Versions diffs - 2.0.dev3__tar.gz → 2.0.dev4__tar.gz - Mend

mkdocs 2.0.dev3tar.gz → 2.0.dev4tar.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 (344) hide show

mkdocs-2.0.dev4/PKG-INFO ADDED Viewed

@@ -0,0 +1,72 @@
+Metadata-Version: 2.5
+Name: mkdocs
+Version: 2.0.dev4
+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.dev6
+Requires-Dist: jinja2
+Requires-Dist: markdown
+Description-Content-Type: text/markdown
+# 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.toc.title }}</title>
+        <link rel="stylesheet" href="{{ '/css/default.css' | url }}">
+    </head>
+    <body>
+        <main>
+            {{ page.html }}
+        </main>
+    </body>
+</html>
+```

mkdocs-2.0.dev4/docs/CHANGELOG.md ADDED Viewed

@@ -0,0 +1,7 @@
+## 2.0.dev4
+**Navigation Support**
+Preliminary support for site navigation.
+See [#49](https://github.com/encode/mkdocs/pull/49) for further details.

mkdocs-2.0.dev4/docs/LICENSE.md ADDED Viewed

@@ -0,0 +1,9 @@
+Copyright © 2026, Encode OSS Ltd.
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+<p align="center">&mdash; 💖 &mdash;</p>

mkdocs-2.0.dev4/docs/css/theme.css ADDED Viewed

@@ -0,0 +1,300 @@
+/* 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: 0 auto 0 auto;
+    width: 60%;
+    padding: 1rem;
+}
+@media (max-width: 1000px) {
+    main {
+        padding: 1.5rem 1rem;
+        width: 75%;
+    }
+    nav.toc {
+        display: none;
+    }
+}
+@media (max-width: 750px) {
+    main {
+        padding: 1.5rem 1rem;
+        width: 100%;
+    }
+    nav.toc {
+        display: none;
+    }
+    nav.site {
+        display: none;
+    }
+}
+/* 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;
+    --border-color: linear-gradient(to right, #ffafc7 10%, #73d7ee 10% 20%, #613915 20% 30%, #000000 30% 40%, #e50000 40% 50%, #ff8d00 50% 60%, #ffee00 60% 70%, #028121 70% 80%, #004cff 80% 90%, #760088 90%);
+    border-top: 0.5em solid;
+    border-bottom: 0.5em solid;
+    border-image: var(--border-color) 1;
+}
+h1, h2, h3, h4, h5 {
+    margin-top: 1.5rem;
+    margin-bottom: 1.5rem;
+    line-height: 1.3;
+}
+h1 {
+    font-family: courier;
+    text-align: center;
+    font-size: 3.5rem;
+    border-top: 1px solid var(--neutral-color);
+    border-bottom: 1px solid var(--neutral-color);
+}
+h2 {
+    border-bottom: 1px solid var(--neutral-color);
+    padding-bottom: 0.3rem;
+    font-size: 1.5rem;
+    margin-top: 3.5rem;
+}
+h3 { font-size: 1.25rem; }
+h4 { font-size: 1rem; }
+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 {
+    background: var(--code-bg-color);
+}
+code {
+    background: var(--code-bg-color);
+    padding: 5px;
+}
+pre code {
+    color: var(--code-bg-color);
+}
+h1 a {
+    color: inherit;
+}
+h1 a:hover {
+    text-decoration: none;
+}
+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;
+}
+h2 a.toclink:hover::after {
+    content: "#";
+    margin: 0 0.8rem;
+    color: var(--neutral-color);
+}
+/* Alerts */
+.admonition           { border-left: 5px solid; padding-left: 20px;}
+.admonition.note      { border-left-color: var(--accent-note); }
+.admonition.tip       { border-left-color: var(--accent-tip); }
+.admonition.important { border-left-color: var(--accent-important); }
+.admonition.warning   { border-left-color: var(--accent-warning); }
+.admonition.caution   { border-left-color: var(--accent-caution); }
+.admonition           .admonition-title { font-weight: 600; margin: 0 0 .5em; }
+.admonition.note      .admonition-title { color: var(--accent-note); }
+.admonition.tip       .admonition-title { color: var(--accent-tip); }
+.admonition.important .admonition-title { color: var(--accent-important); }
+.admonition.warning   .admonition-title { color: var(--accent-warning); }
+.admonition.caution   .admonition-title { color: var(--accent-caution); }
+/* Pagination styling */
+div.pagination {
+    height: 1.5rem;
+    border-top: 3px solid var(--neutral-color);
+    padding: 1rem 0;
+}
+div.pagination a.previous {
+    float: left;
+    text-decoration: none;
+}
+div.pagination a.next {
+    float: right;
+    text-decoration: none;
+}
+/* Navigation styling */
+nav.site {
+    position: fixed;
+    width : 20%;
+    padding: 2rem;
+    height: 100%;
+    overflow-y: scroll;
+}
+nav.site ul {
+    padding: 0;
+    margin: 0;
+}
+nav.site li {
+    padding: 0;
+    margin: 0.5rem 0;
+    display: block;
+}
+nav.site li a.active {
+    color: var(--link-color);
+}
+nav.site li a:hover {
+    color: var(--link-color);
+    text-decoration: none;
+}
+nav.site li a {
+    color: var(--muted-fg-color);
+}
+nav.site li a:hover {
+    color: var(--fg-color);
+    text-decoration: none;
+}
+/* Table of contents styling */
+nav.toc {
+    position: fixed;
+    margin-left: 80%;
+    width : 20%;
+    padding: 2rem;
+    height: 100%;
+    overflow-y: scroll;
+}
+nav.toc ul {
+    padding: 0;
+    margin: 0;
+}
+nav.toc li {
+    padding: 0;
+    margin: 0.5rem 0;
+    display: block;
+}
+nav.toc li a.active {
+    color: var(--link-color);
+}
+nav.toc li a:hover {
+    color: var(--link-color);
+    text-decoration: none;
+}
+nav.toc li a {
+    color: var(--muted-fg-color);
+}
+nav.toc li a:hover {
+    color: var(--fg-color);
+    text-decoration: none;
+}
+/* Navigation styling */

mkdocs-2.0.dev4/docs/templates/base.html ADDED Viewed

@@ -0,0 +1,25 @@
+<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;">
+        <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="site">
+            {{ nav.html }}
+        </nav>
+        <nav class="toc">
+            {{ page.toc.html }}
+        </nav>
+        <main>
+            {{ page.html }}
+        </main>
+    </body>
+</html>

{mkdocs-2.0.dev3 → mkdocs-2.0.dev4}/pyproject.toml RENAMED Viewed

@@ -5,6 +5,7 @@ build-backend = "hatchling.build"
 [project]
 name = "mkdocs"
 description = "HTTP, for Python."
+readme = "docs/README.md"
 requires-python = ">=3.10"
 authors = [
     { name = "Kim Christie", email = "noreply@lovelydinosaur.com" },
@@ -22,7 +23,7 @@ classifiers = [
     "Topic :: Internet :: WWW/HTTP",
 ]
 dependencies = [
-    "httpx>=1.0.dev5",
+    "httpx>=1.0.dev6",
     "click",
     "jinja2",
     "markdown",

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

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

{mkdocs-2.0.dev3 → mkdocs-2.0.dev4}/src/mkdocs/extensions/relative_urls.py RENAMED Viewed

@@ -34,7 +34,7 @@ class URLProcessor(markdown.treeprocessors.Treeprocessor):
                     path_from = page.path
                     path_to = os.path.normpath(path_from.parent.joinpath(url.path))
-                    target = site.lookup.get(path_to)
+                    target = site.lookup_by_path(path_to)
                     if target is None:
                         continue  # Broken link!

{mkdocs-2.0.dev3 → mkdocs-2.0.dev4}/src/mkdocs/mkdocs.py RENAMED Viewed

@@ -20,7 +20,7 @@ RESET = '\033[0m'
 # The build context is used to ensure the current page and the site index
 # are available to the RelativeURLs markdown extension.
 _current_page = contextvars.ContextVar('current_page')
-_site_index = contextvars.ContextVar('site_index')
+_site = contextvars.ContextVar('site')
 def get_current_page():
@@ -31,7 +31,7 @@ def get_current_page():
 def get_site():
-    ctx = _site_index.get()
+    ctx = _site.get()
     if ctx is None:
         raise RuntimeError("No current context")
     return ctx
@@ -64,13 +64,19 @@ class Site:
         self._pages = pages
         self._statics = statics
-        self.lookup = {
+        self._paths = {
             str(resource.path): resource for resource in pages + statics
         }
-        self.lookup_by_url = {
+        self._urls = {
             str(resource.url): resource for resource in pages + statics
         }
+    def lookup_by_path(self, path) -> Page | Static | None:
+        return self._paths.get(path)
+    def lookup_by_url(self, url) -> Page | Static | None:
+        return self._urls.get(url)
     @property
     def pages(self) -> list[Page]:
         return list(self._pages)
@@ -93,6 +99,26 @@ class TableOfContents:
         return bool(self._items)
+class NavItem:
+    def __init__(self, title: str, page: Page):
+        self.title = title
+        self.page = page
+class Navigation:
+    def __init__(self, nav_items):
+        self._items = nav_items
+    def __iter__(self):
+        return iter(self._items)
+    @property
+    def html(self):
+        page = get_current_page()
+        t = jinja2.Template("""<ul>{% for item in nav %}<li><a href="{{ item.page.url }}"  {% if item.page == page %}class="active"{% endif %}>{{ item.title }}</a></li>{% endfor %}</ul>""")
+        return t.render({"nav": self, "page": page})
 class PageContext:
     def __init__(self, page, text, html, toc):
         self.path = page.path
@@ -110,7 +136,8 @@ class PageContext:
 class MkDocs:
     def __init__(self, input_dir):
-        self.site_index = self.load_site(input_dir)
+        self.site = self.load_site(input_dir)
+        self.nav = self.load_nav({}, self.site)
         self.env = self.init_env(input_dir)
         self.md = self.init_md()
         self.base = self.env.get_template('base.html')
@@ -140,6 +167,29 @@ class MkDocs:
         statics = sorted(statics, key=lambda x: x.url)
         return Site(pages, statics)
+    def load_nav(self, config, site):
+        if not config:
+            config = {"nav": [
+                {"title": page.path.stem, "path": str(page.path)}
+                for page in site.pages
+            ]}
+        nav_config = config.get('nav', [])
+        nav_config = nav_config if isinstance(nav_config, list) else []
+        nav_items = []
+        for item in nav_config:
+            if not isinstance(item, dict):
+                continue
+            path = item.get('path', '')
+            title = item.get('title', '')
+            if not path:
+                continue
+            if path:
+                page = site.lookup_by_path(path)
+            nav_item = NavItem(title, page)
+            nav_items.append(nav_item)
+        return Navigation(nav_items)
     def init_env(self, input_dir) -> jinja2.Environment:
         @jinja2.pass_context
         def url(ctx, url_to):
@@ -178,19 +228,21 @@ class MkDocs:
     @contextlib.contextmanager
     def set_context(self, current_page):
         token_page = _current_page.set(current_page)
-        token_site = _site_index.set(self.site_index)
+        token_site = _site.set(self.site)
         try:
             yield
         finally:
             _current_page.reset(token_page)
-            _site_index.reset(token_site)
+            _site.reset(token_site)
+    # Commands...
     def build(self, input, output):
         input_dir = pathlib.Path(input)
         output_dir = pathlib.Path(output)
-        print(DARK_GRAY + "Collected %d resources" % len(self.site_index) + RESET)
-        for page in self.site_index.pages:
+        print(DARK_GRAY + "Collected %d resources" % len(self.site) + RESET)
+        for page in self.site.pages:
             print(GREEN + " + " + RESET + BOLD + str(page.path) + RESET + DARK_GRAY + " [markdown]" + RESET)
             input_path = input_dir.joinpath(page.path)
             output_path = output_dir.joinpath(page.build_path)
@@ -200,12 +252,12 @@ class MkDocs:
                 html = self.md.reset().convert(text)
                 toc = TableOfContents(self.md)
                 page_ctx = PageContext(page=page, text=text, html=html, toc=toc)
-                output = self.base.render(page=page_ctx)
+                output = self.base.render(page=page_ctx, nav=self.nav)
             output_path.parent.mkdir(parents=True, exist_ok=True)
             output_path.write_text(output)
-        for static in self.site_index.statics:
+        for static in self.site.statics:
             print(GREEN + " + " + RESET + BOLD + str(static.path) + RESET + DARK_GRAY + " [static]" + RESET)
             input_path = input_dir.joinpath(static.path)
             output_path = output_dir.joinpath(static.path)
@@ -216,15 +268,15 @@ class MkDocs:
     def serve(self, input):
         input_dir = pathlib.Path(input)
-        print(DARK_GRAY + "Serving %d resources" % len(self.site_index) + RESET)
-        for page in self.site_index.pages:
+        print(DARK_GRAY + "Serving %d resources" % len(self.site) + RESET)
+        for page in self.site.pages:
             print(GREEN + " + " + RESET + BOLD + str(page.url) + RESET + DARK_GRAY + " [markdown]" + RESET)
-        for static in self.site_index.statics:
+        for static in self.site.statics:
             print(GREEN + " + " + RESET + BOLD + str(static.url) + RESET + DARK_GRAY + " [static]" + RESET)
         print()
         def app(request):
-            resource = self.site_index.lookup_by_url.get(request.url.path)
+            resource = self.site.lookup_by_url(request.url.path)
             if isinstance(resource, Page):
                 input_path = input_dir.joinpath(resource.path)
@@ -233,7 +285,7 @@ class MkDocs:
                     html = self.md.reset().convert(text)
                     toc = TableOfContents(self.md)
                     page_ctx = PageContext(page=resource, text=text, html=html, toc=toc)
-                    output = self.base.render(page=page_ctx)
+                    output = self.base.render(page=page_ctx, nav=self.nav)
                 return httpx.Response(200, content=httpx.HTML(output))
             elif isinstance(resource, Static):
                 input_path = input_dir.joinpath(resource.path)
@@ -244,6 +296,8 @@ class MkDocs:
         server.serve()
+# Command line client...
 @click.group()
 def cli():
     if pathlib.Path('mkdocs.yml').exists():

mkdocs 2.0.dev3__tar.gz → 2.0.dev4__tar.gz

mkdocs 2.0.dev3tar.gz → 2.0.dev4tar.gz