PyPI - mkdocs-dsfr - Versions diffs - 0.0.1__tar.gz - Mend

mkdocs-dsfr 0.0.1__tar.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 (650) hide show

mkdocs-dsfr-0.0.1/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2023 Ministère de la Transition Écologique
+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.

mkdocs-dsfr-0.0.1/MANIFEST.in ADDED Viewed

@@ -0,0 +1,4 @@
+recursive-include dsfr *.ico *.js *.css *.png *.html *.eot *.svg *.ttf *.woff *.webmanifest *.map *.woff2
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+prune mkdocs

mkdocs-dsfr-0.0.1/PKG-INFO ADDED Viewed

@@ -0,0 +1,10 @@
+Metadata-Version: 2.1
+Name: mkdocs-dsfr
+Version: 0.0.1
+Summary: DSFR theme for Mkdocs
+Home-page: https://www.systeme-de-design.gouv.fr
+Author: Ministère Transition Écologique - DNUM
+Author-email: numerique-ecologie@developpement-durable.gouv.fr
+License: MIT
+Requires-Python: >=3.7
+License-File: LICENSE

mkdocs-dsfr-0.0.1/README.md ADDED Viewed

@@ -0,0 +1,10 @@
+> WARNING: This theme is only meant to be used for official French's public service websites and apps.
+> Its main purpose is to make it easy to identify governmental websites for citizens. [See terms](https://www.systeme-de-design.gouv.fr/cgu/).
+# MkDocs DSFR Theme
+## Release Notes
+### Version 0.0.1 (March 2023)
+* Initial realese. Very experimental !

mkdocs-dsfr-0.0.1/dsfr/__init__.py ADDED Viewed

File without changes

mkdocs-dsfr-0.0.1/dsfr/base.html ADDED Viewed

@@ -0,0 +1,76 @@
+<!DOCTYPE html>
+<html lang="fr" data-fr-scheme="system">
+	<head>
+		<meta charset="utf-8">
+		<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+		<link rel="stylesheet" href="{{ "dsfr/dsfr.min.css"|url }}">
+		<link rel="stylesheet" href="{{ "css/theme.css"|url }}">
+		<meta
+		name="theme-color" content="#000091">
+		<!-- Défini la couleur de thème du navigateur (Safari/Android) -->
+		<link
+		rel="apple-touch-icon" href="{{ "favicon/apple-touch-icon.png"|url }}">
+		<!-- 180×180 -->
+		<link rel="icon" href="{{ "favicon/favicon.svg"|url }}" type="image/svg+xml">
+		<link
+		rel="shortcut icon" href="{{ "favicon/favicon.ico"|url }}">
+		<!-- 32×32 -->
+		<link rel="manifest" href="{{ "favicon/manifest.webmanifest"|url }}" crossorigin="use-credentials">
+		<!-- Modifier les chemins relatifs des favicons en fonction de la structure du projet -->
+		<!-- Dans le fichier manifest.webmanifest aussi, modifier les chemins vers les images -->
+			{% for path in config.extra_css %}
+		<link href="{{ path|url }}" rel="stylesheet"> {% endfor %}
+		<title>
+			{% if page.title %}
+				{{ page.title }}
+				-
+			{% endif %}
+			{{ config.site_name }}
+		</title>
+		{% block extrahead %}{% endblock %}
+		{%- block libs %}
+			<script src="{{ 'js/jquery-1.10.2.min.js'|url }}" defer></script>
+			<script src="{{ 'js/bootstrap.min.js'|url }}" defer></script>
+		{%- endblock %}
+	</head>
+	<body>
+		{% include "header.html" %}
+		<main id="content" role="main">
+			<div class="fr-container">
+				<div class="fr-grid-row">
+					{% if config.theme.menulateral %}
+						{% include "lateral.html" %}
+						<div id="contenu" class="fr-col-12 fr-col-md-9 fr-py-12v">
+					{% else %}
+						<div id="contenu" class="fr-col-12 fr-col-md-12 fr-py-12v">
+					{% endif %}
+					{% block content %}
+						{{ page.content }}
+					{% endblock %}
+					</div>
+					<hr/>
+					{% include "prev-next-nav.html" %}
+				</div>
+			</div>
+		</main>
+			<!--MkDocs version      : {{ mkdocs_version }}
+				Docs Build Date UTC : {{ build_date_utc }}-->
+			<!-- Script en version es6 module et nomodule pour les navigateurs le ne supportant pas -->
+		{%- block scripts %}
+			<script>
+				var base_url = {{ base_url | tojson }},
+					shortcuts = {{ config.theme.shortcuts | tojson }};
+			</script>
+			<script type="module" src="{{ "dsfr/dsfr.module.min.js"|url }}"></script>
+			<script type="text/javascript" nomodule src="{{ "dsfr/dsfr.nomodule.min.js"|url }}"></script>
+			<script src="https://code.jquery.com/jquery-3.6.3.min.js" integrity="sha256-pvPw+upLPUjgMXY0G+8O0xUf+/Im1MZjXxxgOcBQBXU=" crossorigin="anonymous"></script>
+			<script src="{{ 'js/base.js'|url }}" defer></script>
+			{%- for path in extra_javascript %}
+			<script src="{{ path }}" defer></script>
+			{%- endfor %}
+		{%- endblock %}
+	</body>
+</html>

mkdocs-dsfr-0.0.1/dsfr/css/theme.css ADDED Viewed

@@ -0,0 +1,228 @@
+h2 {
+    margin-top: 4rem;
+}
+h3 {
+    margin-top: 3rem;
+}
+h4 {
+    margin-top: 2rem;
+}
+h1:hover .headerlink::before,
+h2:hover .headerlink::before {
+    content: url(../dsfr/icons/business/links-line.svg);
+    filter: invert(55%) sepia(89%) saturate(3378%) hue-rotate(217deg) brightness(109%) contrast(93%);
+}
+h1:hover .headerlink,
+h2:hover .headerlink {
+    margin: 0 10px
+}
+img {
+    max-width: -webkit-fill-available;
+}
+pre,
+.rst-content tt {
+    padding: 2em 1em;
+    background: #f5f2f0;
+    margin: 0.5em 0;
+    overflow: auto;
+    color: #000;
+    text-shadow: 0 1px #fff;
+    font-family: Consolas, Monaco, Andale Mono, Ubuntu Mono, monospace;
+    font-size: 1em;
+    text-align: left;
+    white-space: pre;
+    word-spacing: normal;
+    word-break: normal;
+    word-wrap: normal;
+    line-height: 1.5;
+    -moz-tab-size: 4;
+    -o-tab-size: 4;
+    tab-size: 4;
+    -webkit-hyphens: none;
+    -ms-hyphens: none;
+    hyphens: none;
+}
+code:not(pre code) {
+    padding: 2px 5px;
+    margin: 0px 2px;
+    background-color: rgba(0, 0, 0, 0.5);
+    border: solid 1px #fff;
+    color: white;
+    white-space: pre-wrap;
+    word-wrap: break-word;
+}
+.admonition .fr-display-lg,
+.admonition .fr-display-md,
+.admonition .fr-display-sm,
+.admonition .fr-display-xl,
+.admonition .fr-display-xs,
+.admonition .fr-h1,
+.admonition .fr-h2,
+.admonition .fr-h3,
+.admonition .fr-h4,
+.admonition .fr-h5,
+.admonition .fr-h6,
+.admonition h1,
+.admonition h2,
+.admonition h3,
+.admonition h4,
+.admonition h5,
+.admonition h6 {
+    mix-blend-mode: difference;
+}
+.admonition {
+    --title-spacing: 0 0 0.5rem;
+    --text-spacing: 0;
+    --idle: transparent;
+    margin: 0 0 1.5rem;
+    padding: 1.5rem;
+    position: relative;
+}
+div.admonition.block>.admonition-title {
+    display: none;
+}
+.admonition.note {
+    --text-spacing: 0;
+    --hover: var(--background-contrast-grey-hover);
+    --active: var(--background-contrast-grey-active);
+    background-color: var(--background-contrast-grey);
+    box-shadow: inset 0.25rem 0 0 0 var(--border-default-blue-france);
+}
+.admonition.warning {
+    --hover: var(--background-contrast-brown-caramel-hover);
+    --active: var(--background-contrast-brown-caramel-active);
+    background-color: var(--background-contrast-brown-caramel);
+    box-shadow: inset 0.25rem 0 0 0 var(--border-default-brown-caramel);
+}
+.admonition.new {
+    --hover: var(--background-contrast-green-emeraude-hover);
+    --active: var(--background-contrast-green-emeraude-active);
+    background-color: var(--background-contrast-green-emeraude);
+    box-shadow: inset 0.25rem 0 0 0 var(--border-default-green-emeraude);
+}
+.admonition-title {
+    font-size: 1.5rem;
+    line-height: 2rem;
+}
+.admonition.example {
+    color: #353579;
+    background-color: #f0f1ff;
+    border-color: #d8dcf0;
+}
+details.exemple summary {
+    --text-spacing: 0;
+    --title-spacing: 0;
+    align-items: center;
+    color: var(--text-action-high-grey);
+    display: inline-flex;
+    flex-direction: row;
+    font-size: 1rem;
+    line-height: 1.5rem;
+    margin: 0;
+    max-height: none;
+    max-width: 100%;
+    min-height: 3rem;
+    overflow: initial;
+    padding: 0.75rem 0;
+    text-align: left;
+    width: -moz-fit-content;
+    width: -webkit-fit-content;
+    width: fit-content;
+    width: 100%;
+    z-index: 1;
+}
+details.exemple {
+    text-rendering: optimizeLegibility;
+    -webkit-font-smoothing: antialiased;
+    -moz-osx-font-smoothing: grayscale;
+    -webkit-text-size-adjust: 100%;
+    --idle: transparent;
+    --hover: var(--background-default-grey-hover);
+    --active: var(--background-default-grey-active);
+    background-color: var(--background-default-grey);
+    color: var(--text-default-grey);
+    font-family: Marianne, arial, sans-serif;
+    font-size: 1rem;
+    line-height: 1.5rem;
+    margin: 0;
+    padding: 0;
+}
+.doc.doc-object.doc-attribute {
+    box-shadow: inset 0.25rem 0 0 0 var(--border-default-blue-france);
+    font-size: 1rem;
+    line-height: 1.5rem;
+        margin: 30px 0px;
+    margin-left: 2rem;
+    padding-left: 2rem
+}
+.doc h5 {
+    font-size: 1.1rem;
+    margin: 0;
+    padding: 15px 0;
+}
+table {
+    /* display: block; */
+    overflow: auto;
+    width: 100%;
+    display: table;
+    border-collapse: separate;
+    box-sizing: border-box;
+    text-indent: initial;
+    border-spacing: 2px;
+    border-color: gray;
+    margin-bottom: 25px;
+}
+thead {
+    --idle: transparent;
+    --hover: var(--background-contrast-grey-hover);
+    --active: var(--background-contrast-grey-active);
+    background-color: var(--background-contrast-grey);
+    background-image: linear-gradient(0deg, var(--border-plain-grey), var(--border-plain-grey));
+    background-position: bottom;
+    background-repeat: no-repeat;
+    background-size: 100% 2px;
+    color: var(--text-title-grey);
+}
+tbody {
+    --idle: transparent;
+    --hover: var(--background-alt-grey-hover);
+    --active: var(--background-alt-grey-active);
+    background-color: var(--background-alt-grey);
+}
+tbody tr:nth-child(2n) {
+    --idle: transparent;
+    --hover: var(--background-contrast-grey-hover);
+    --active: var(--background-contrast-grey-active);
+    background-color: var(--background-contrast-grey);
+}
+td,
+th {
+    border: 0;
+    display: table-cell;
+    font-size: .875rem;
+    line-height: 1.5rem;
+    padding: 0.75rem;
+    text-align: left;
+    vertical-align: middle;
+}