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

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: mkdocs
-Version: 2.0.dev2
+Version: 2.0.dev3
 Summary: HTTP, for Python.
 Author-email: Kim Christie <noreply@lovelydinosaur.com>
 Classifier: Development Status :: 4 - Beta

{mkdocs-2.0.dev2 → mkdocs-2.0.dev3}/docs/README.md RENAMED Viewed

@@ -1,7 +1,3 @@
-<style>
-h2 { margin-top: 50px}
-</style>
 # MkDocs
 MkDocs is a smart, simple, website design tool.
@@ -42,7 +38,7 @@ A starting point can be as simple as...
     <head>
         <meta charset="utf-8">
         <meta name="viewport" content="width=device-width, initial-scale=1.0">
-        <title>{{ page.title }}</title>
+        <title>{{ page.toc.title }}</title>
         <link rel="stylesheet" href="{{ '/css/default.css' | url }}">
     </head>
     <body>
@@ -51,4 +47,4 @@ A starting point can be as simple as...
         </main>
     </body>
 </html>
-```
+```

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

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

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

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

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

@@ -8,7 +8,7 @@ import httpx
 class URLProcessor(markdown.treeprocessors.Treeprocessor):
     def run(self, root):
         page = mkdocs.get_current_page()
-        site_index = mkdocs.get_site_index()
+        site = mkdocs.get_site()
         key = ''
         link = ''
@@ -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_index.lookup.get(path_to)
+                    target = site.lookup.get(path_to)
                     if target is None:
                         continue  # Broken link!

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

@@ -30,7 +30,7 @@ def get_current_page():
     return ctx
-def get_site_index():
+def get_site():
     ctx = _site_index.get()
     if ctx is None:
         raise RuntimeError("No current context")
@@ -52,14 +52,6 @@ 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
@@ -67,7 +59,7 @@ class Static:
         self.url = str(url).removesuffix('index.html')
-class SiteIndex:
+class Site:
     def __init__(self, pages, statics):
         self._pages = pages
         self._statics = statics
@@ -91,6 +83,31 @@ class SiteIndex:
         return len(self.pages) + len(self.statics)
+class TableOfContents:
+    def __init__(self, md):
+        self.html = md.toc
+        self.title = md.toc_tokens[0]['name'] if md.toc_tokens else ''
+        self._items = list(md.toc_tokens)
+    def __bool__(self):
+        return bool(self._items)
+class PageContext:
+    def __init__(self, page, text, html, toc):
+        self.path = page.path
+        self.url = page.url
+        self.text = text
+        self.html = html
+        self.toc = toc
+    # Leaving this here for compatability with... `{{ page.title }}`
+    # TODO.... probably deprecate, but follow through with toc design discussion.
+    @property
+    def title(self):
+        return self.toc.title
 class MkDocs:
     def __init__(self, input_dir):
         self.site_index = self.load_site(input_dir)
@@ -121,7 +138,7 @@ class MkDocs:
         pages = sorted(pages, key=lambda x: x.url)
         statics = sorted(statics, key=lambda x: x.url)
-        return SiteIndex(pages, statics)
+        return Site(pages, statics)
     def init_env(self, input_dir) -> jinja2.Environment:
         @jinja2.pass_context
@@ -154,7 +171,7 @@ class MkDocs:
             ],
             extension_configs={
                 'footnotes': {'BACKLINK_TITLE': ''},
-                'toc': {'anchorlink': True, 'marker': ''}
+                'toc': {'anchorlink': True, 'marker': '', 'toc_class': ''}
             }
         )
@@ -181,9 +198,9 @@ class MkDocs:
             with self.set_context(page):
                 text = input_path.read_text()
                 html = self.md.reset().convert(text)
-                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)
+                toc = TableOfContents(self.md)
+                page_ctx = PageContext(page=page, text=text, html=html, toc=toc)
+                output = self.base.render(page=page_ctx)
             output_path.parent.mkdir(parents=True, exist_ok=True)
             output_path.write_text(output)
@@ -214,9 +231,9 @@ class MkDocs:
                 with self.set_context(resource):
                     text = input_path.read_text()
                     html = self.md.reset().convert(text)
-                    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)
+                    toc = TableOfContents(self.md)
+                    page_ctx = PageContext(page=resource, text=text, html=html, toc=toc)
+                    output = self.base.render(page=page_ctx)
                 return httpx.Response(200, content=httpx.HTML(output))
             elif isinstance(resource, Static):
                 input_path = input_dir.joinpath(resource.path)

{mkdocs-2.0.dev2 → mkdocs-2.0.dev3}/src/mkdocs/theme/base.html RENAMED Viewed

@@ -35,24 +35,26 @@
 /* Layout... */
 main {
-    margin-left: 20%;
+    margin: 0 auto;
+    max-width: 700px;
     width: 60%;
-    padding: 1rem;
+    padding: 1rem 0;
 }
 @media (max-width: 1000px) {
     main {
-        padding: 1.5rem 1rem;
         width: 75%;
-        margin-left: 25%;
+    }
+    nav.toc {
+        display: none;
     }
 }
-@media (max-width: 800px) {
+@media (max-width: 600px) {
     main {
-        padding: 1.5rem 1rem;
         width: 100%;
-        margin-left: 0;
+        padding: 1rem 1.5rem;
     }
 }
@@ -163,9 +165,56 @@ a.toclink:hover::after {
     margin: 0 0.8rem;
     color: var(--neutral-color);
 }
+/* Table of contents styling */
+nav.toc {
+    position: fixed;
+    margin-left: 80%;
+    width : 20%;
+    padding: 2rem;
+    height: 100%;
+    overflow-y: scroll;
+}
+/* Navigation styling */
+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;
+}
         </style>
     </head>
     <body>
+        {% if page.toc %}
+        <nav class="toc">
+            {{ page.toc.html }}
+        </nav>
+        {% endif %}
         <main>
             {{ page.html }}
         </main>

mkdocs-2.0.dev3/themes/default/css/highlightjs-copy.min.css ADDED Viewed

@@ -0,0 +1 @@

+ .hljs-copy-wrapper{position:relative;overflow:hidden;transform:translateZ(0)}.hljs-copy-container{--hljs-theme-padding:16px;position:absolute;top:0;right:0;transition:transform 200ms ease-out}.hljs-copy-button{position:relative;margin:calc(var(--hljs-theme-padding) / 2);width:calc(16px + var(--hljs-theme-padding));height:calc(16px + var(--hljs-theme-padding));font-size:.8125rem;text-indent:-9999px;color:var(--hljs-theme-color);border-radius:.25rem;border:1px solid;border-color:color-mix(in srgb,var(--hljs-theme-color),transparent 80%);background-color:var(--hljs-theme-background);transition:background-color 200ms ease;overflow:hidden}.hljs-copy-button:not([data-copied="true"])::before{content:"";width:1rem;height:1rem;top:50%;left:50%;transform:translate(-50%,-50%);position:absolute;background-color:currentColor;mask:url('data:image/svg+xml;utf-8,<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M6 5C5.73478 5 5.48043 5.10536 5.29289 5.29289C5.10536 5.48043 5 5.73478 5 6V20C5 20.2652 5.10536 20.5196 5.29289 20.7071C5.48043 20.8946 5.73478 21 6 21H18C18.2652 21 18.5196 20.8946 18.7071 20.7071C18.8946 20.5196 19 20.2652 19 20V6C19 5.73478 18.8946 5.48043 18.7071 5.29289C18.5196 5.10536 18.2652 5 18 5H16C15.4477 5 15 4.55228 15 4C15 3.44772 15.4477 3 16 3H18C18.7956 3 19.5587 3.31607 20.1213 3.87868C20.6839 4.44129 21 5.20435 21 6V20C21 20.7957 20.6839 21.5587 20.1213 22.1213C19.5587 22.6839 18.7957 23 18 23H6C5.20435 23 4.44129 22.6839 3.87868 22.1213C3.31607 21.5587 3 20.7957 3 20V6C3 5.20435 3.31607 4.44129 3.87868 3.87868C4.44129 3.31607 5.20435 3 6 3H8C8.55228 3 9 3.44772 9 4C9 4.55228 8.55228 5 8 5H6Z" fill="black"/><path fill-rule="evenodd" clip-rule="evenodd" d="M7 3C7 1.89543 7.89543 1 9 1H15C16.1046 1 17 1.89543 17 3V5C17 6.10457 16.1046 7 15 7H9C7.89543 7 7 6.10457 7 5V3ZM15 3H9V5H15V3Z" fill="black"/></svg>');mask-repeat:no-repeat;mask-size:contain;mask-position:center center}.hljs-copy-button:hover{background-color:color-mix(in srgb,var(--hljs-theme-color),transparent 90%)}.hljs-copy-button:active{border-color:color-mix(in srgb,var(--hljs-theme-color),transparent 60%)}.hljs-copy-button[data-copied="true"]{text-indent:0}.hljs-copy-container[data-autohide="true"]{transform:translateX(calc(100% + 1.125em))}.hljs-copy-wrapper:focus-within .hljs-copy-container{transition:none;transform:translateX(0)}.hljs-copy-wrapper:hover .hljs-copy-container{transform:translateX(0)}@media(prefers-reduced-motion){.hljs-copy-button{transition:none}}.hljs-copy-alert{clip:rect(0 0 0 0);clip-path:inset(50%);height:1px;overflow:hidden;position:absolute;white-space:nowrap;width:1px}

mkdocs-2.0.dev3/themes/default/css/highlightjs.min.css ADDED Viewed

@@ -0,0 +1,10 @@
+pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}/*!
+  Theme: GitHub Dark
+  Description: Dark theme as seen on github.com
+  Author: github.com
+  Maintainer: @Hirse
+  Updated: 2021-05-15
+  Outdated base version: https://github.com/primer/github-syntax-dark
+  Current colors taken from GitHub's CSS
+*/.hljs{color:#c9d1d9;background:#0d1117}.hljs-doctag,.hljs-keyword,.hljs-meta .hljs-keyword,.hljs-template-tag,.hljs-template-variable,.hljs-type,.hljs-variable.language_{color:#ff7b72}.hljs-title,.hljs-title.class_,.hljs-title.class_.inherited__,.hljs-title.function_{color:#d2a8ff}.hljs-attr,.hljs-attribute,.hljs-literal,.hljs-meta,.hljs-number,.hljs-operator,.hljs-selector-attr,.hljs-selector-class,.hljs-selector-id,.hljs-variable{color:#79c0ff}.hljs-meta .hljs-string,.hljs-regexp,.hljs-string{color:#a5d6ff}.hljs-built_in,.hljs-symbol{color:#ffa657}.hljs-code,.hljs-comment,.hljs-formula{color:#8b949e}.hljs-name,.hljs-quote,.hljs-selector-pseudo,.hljs-selector-tag{color:#7ee787}.hljs-subst{color:#c9d1d9}.hljs-section{color:#1f6feb;font-weight:700}.hljs-bullet{color:#f2cc60}.hljs-emphasis{color:#c9d1d9;font-style:italic}.hljs-strong{color:#c9d1d9;font-weight:700}.hljs-addition{color:#aff5b4;background-color:#033a16}.hljs-deletion{color:#ffdcd7;background-color:#67060c}

mkdocs-2.0.dev3/themes/default/css/theme.css ADDED Viewed

@@ -0,0 +1,257 @@
+/* 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... */
+nav.left {
+    position: fixed;
+    width : 20%;
+    padding: 2rem 1rem 1rem 2rem;
+    height: 100%;
+    overflow-y: scroll;
+}
+main {
+    margin-left: 20%;
+    width: 60%;
+    padding: 1rem;
+}
+nav.right {
+    position: fixed;
+    margin-left: 80%;
+    width : 20%;
+    padding: 2rem 2rem 1rem 1rem;
+    height: 100%;
+    overflow-y: scroll;
+}
+@media (max-width: 1000px) {
+    main {
+        padding: 1.5rem 1rem;
+        width: 75%;
+        margin-left: 25%;
+    }
+    nav.left {
+        padding: 2rem 1rem 1rem 2rem;
+        width: 25%;
+        position: fixed;
+    }
+    nav.right {
+        display: none;
+    }
+}
+@media (max-width: 800px) {
+    main {
+        padding: 1.5rem 1rem;
+        width: 100%;
+        margin-left: 0;
+    }
+    nav.left {
+        display: none;
+    }
+    nav.right {
+        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;
+}
+h1, h2 {
+    border-bottom: 1px solid var(--neutral-color);
+    padding-bottom: 0.3rem;
+}
+h1, h2, h3, h4, h5 {
+    margin-top: 1.5rem;
+    margin-bottom: 1.5rem;
+    line-height: 1.3;
+}
+h1 { font-size: 2rem; }
+h2 { 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 {
+    margin-bottom: 1.5rem;
+    padding-left: 2rem;
+}
+li {
+    margin-bottom: 0.5rem;
+}
+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);
+}
+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);
+}
+/* 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); }
+/* Navigation styling */
+nav ul {
+    padding: 0;
+    margin: 0;
+}
+nav li {
+    padding: 0;
+    margin: 0.5rem 0;
+    display: block;
+}
+nav li a {
+    color: var(--fg-color);
+}
+nav li a.active {
+    color: var(--link-color);
+}
+nav li a:hover {
+    color: var(--link-color);
+    text-decoration: none;
+}
+nav.right li a {
+    color: var(--muted-fg-color);
+}
+nav.right li a:hover {
+    color: var(--fg-color);
+    text-decoration: none;
+}
+/* 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;
+}

mkdocs-2.0.dev3/themes/default/js/highlightjs-copy.min.js ADDED Viewed

@@ -0,0 +1 @@

+ class CopyButtonPlugin{constructor(options={}){this.hook=options.hook;this.callback=options.callback;this.lang=options.lang||document.documentElement.lang||"en";this.autohide=typeof options.autohide!=="undefined"?options.autohide:true}"after:highlightElement"({el,text}){if(el.parentElement.querySelector(".hljs-copy-button"))return;let{hook,callback,lang,autohide}=this;let container=Object.assign(document.createElement("div"),{className:"hljs-copy-container"});container.dataset.autohide=autohide;let button=Object.assign(document.createElement("button"),{innerHTML:locales[lang]?.[0]||"Copy",className:"hljs-copy-button"});button.dataset.copied=false;el.parentElement.classList.add("hljs-copy-wrapper");el.parentElement.appendChild(container);container.appendChild(button);container.style.setProperty("--hljs-theme-background",window.getComputedStyle(el).backgroundColor);container.style.setProperty("--hljs-theme-color",window.getComputedStyle(el).color);container.style.setProperty("--hljs-theme-padding",window.getComputedStyle(el).padding);button.onclick=function(){if(!navigator.clipboard)return;let newText=text;if(hook&&typeof hook==="function"){newText=hook(text,el)||text}navigator.clipboard.writeText(newText).then(function(){button.innerHTML=" ✓ ";button.dataset.copied=true;let alert=Object.assign(document.createElement("div"),{role:"status",className:"hljs-copy-alert",innerHTML:locales[lang]?.[2]||"Copied to clipboard"});el.parentElement.appendChild(alert);setTimeout(()=>{button.innerHTML=locales[lang]?.[0]||"Copy";button.dataset.copied=false;el.parentElement.removeChild(alert);alert=null},2e3)}).then(function(){if(typeof callback==="function")return callback(newText,el)})}}}if(typeof module!="undefined"){module.exports=CopyButtonPlugin}const locales={en:["Copy","Copied!","Copied to clipboard"],es:["Copiar","¡Copiado!","Copiado al portapapeles"],"pt-BR":["Copiar","Copiado!","Copiado para a área de transferência"],fr:["Copier","Copié !","Copié dans le presse-papier"],de:["Kopieren","Kopiert!","In die Zwischenablage kopiert"],ja:["コピー","コピーしました！","クリップボードにコピーしました"],ko:["복사","복사됨!","클립보드에 복사됨"],ru:["Копировать","Скопировано!","Скопировано в буфер обмена"],zh:["复制","已复制!","已复制到剪贴板"],"zh-tw":["複製","已複製!","已複製到剪貼簿"]};

mkdocs 2.0.dev2__tar.gz → 2.0.dev3__tar.gz

mkdocs 2.0.dev2tar.gz → 2.0.dev3tar.gz