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

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

{mkdocs-2.0.dev4 → mkdocs-2.0.dev5}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: mkdocs
-Version: 2.0.dev4
+Version: 2.0.dev5
 Summary: HTTP, for Python.
 Author-email: Kim Christie <noreply@lovelydinosaur.com>
 Classifier: Development Status :: 4 - Beta
@@ -24,13 +24,15 @@ Description-Content-Type: text/markdown
 MkDocs is a smart, simple, website design tool.
-Getting started is easy...
+## Installation
+To install MkDocs, run the following command from the command line:
 ```shell
-$ pip install mkdocs --pre
+pip install mkdocs --pre
 ```
-*This will install the version 2.0 pre-release.*
+This will install the version 2.0 pre-release.
 ## Getting started

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

@@ -0,0 +1,11 @@
+## 2.0.dev5
+**Navigation Support Bugfix**
+Use relative URLs for site navigation. Ensures that sites hosted on a subpath still link correctly. [#54](https://github.com/encode/mkdocs/pull/54), [#55](https://github.com/encode/mkdocs/pull/55)
+## 2.0.dev4
+**Navigation Support**
+Preliminary support for site navigation. [#49](https://github.com/encode/mkdocs/pull/49)

{mkdocs-2.0.dev4 → mkdocs-2.0.dev5}/docs/README.md RENAMED Viewed

@@ -2,13 +2,15 @@
 MkDocs is a smart, simple, website design tool.
-Getting started is easy...
+## Installation
+To install MkDocs, run the following command from the command line:
 ```shell
-$ pip install mkdocs --pre
+pip install mkdocs --pre
 ```
-*This will install the version 2.0 pre-release.*
+This will install the version 2.0 pre-release.
 ## Getting started

{mkdocs-2.0.dev4 → mkdocs-2.0.dev5}/docs/templates/base.html RENAMED Viewed

@@ -13,7 +13,7 @@
     </head>
     <body>
         <nav class="site">
-            {{ nav.html }}
+            {% include "navigation.html" %}
         </nav>
         <nav class="toc">
             {{ page.toc.html }}

mkdocs-2.0.dev5/docs/templates/navigation.html ADDED Viewed

@@ -0,0 +1,3 @@
+<ul>
+    {% for item in nav %}<li><a href="{{ item.page.url | url }}"{% if item.page.url == page.url %} class="active"{% endif %}>{{ item.title }}</a></li>{% endfor %}
+</ul>

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

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

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

@@ -40,9 +40,7 @@ class URLProcessor(markdown.treeprocessors.Treeprocessor):
                     url_from = page.url
                     url_to = target.url
-                    rewrite = posixpath.relpath(url_to, url_from)
-                    if url_to.endswith('/') and rewrite != '.':
-                        rewrite += '/'
+                    rewrite = mkdocs.link_to(url_from, url_to)
                     if url.query:
                         rewrite += f'?{url.query}'
                     if url.fragment:

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

@@ -37,6 +37,18 @@ def get_site():
     return ctx
+def link_to(path_from, path_to):
+    if path_from == path_to:
+        return '.'
+    p0 = path_from.split('/')
+    p1 = path_to.split('/')
+    for idx, pair in enumerate(zip(p0, p1)):
+        if pair[0] != pair[1]:
+            break
+    p = ['..' for i in p0[idx+1:]] + p1[idx:]
+    return '/'.join(p)
 class Page:
     def __init__(self, path):
         self.path = path
@@ -194,8 +206,7 @@ class MkDocs:
         @jinja2.pass_context
         def url(ctx, url_to):
             url_from = ctx['page'].url
-            url_rel = posixpath.relpath(url_to, url_from)  # This isn't correct
-            return url_rel
+            return link_to(url_from, url_to)
         dir = pathlib.Path(input_dir)
         loader = jinja2.ChoiceLoader([

{mkdocs-2.0.dev4 → mkdocs-2.0.dev5}/src/mkdocs/theme/base.html RENAMED Viewed

@@ -263,7 +263,7 @@ nav.toc li a:hover {
     <body>
         {% if nav %}
         <nav class="site">
-            {{ nav.html }}
+            {% include "navigation.html" %}
         </nav>
         {% endif %}
         {% if page.toc %}

mkdocs-2.0.dev5/src/mkdocs/theme/navigation.html ADDED Viewed

@@ -0,0 +1,3 @@
+<ul>
+    {% for item in nav %}<li><a href="{{ item.page.url | url }}"{% if item.page.url == page.url %} class="active"{% endif %}>{{ item.title }}</a></li>{% endfor %}
+</ul>

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

@@ -1,7 +0,0 @@
-## 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/src/mkdocs/__version__.py DELETED Viewed

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

mkdocs-2.0.dev4/themes/default/css/highlightjs-copy.min.css DELETED Viewed

@@ -1 +0,0 @@

- .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.dev4/themes/default/css/highlightjs.min.css DELETED Viewed

@@ -1,10 +0,0 @@
-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.dev4/themes/default/css/theme.css DELETED Viewed

@@ -1,257 +0,0 @@
-/* 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.dev4/themes/default/js/highlightjs-copy.min.js DELETED Viewed

@@ -1 +0,0 @@

- 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.dev4__tar.gz → 2.0.dev5__tar.gz

mkdocs 2.0.dev4tar.gz → 2.0.dev5tar.gz