Commit 2f7d35bc authored by Kyodev's avatar Kyodev

maj

parent e52f02ab
Pipeline #16212 passed with stages
in 25 seconds
# test mkdocs
# essai mkdocs
## kyopages
[sur framagit](https://kyodev.frama.io/kyopages/)
## liens
* [gitlab.com/pages/mkdocs](https://gitlab.com/pages/mkdocs)
* [Les Gitlab Pages débarquent dans Framagit !](https://framablog.org/2017/03/20/les-gitlab-pages-debarquent-dans-framagit/)
* [www.mkdocs.org](http://www.mkdocs.org/)
## install en local pour dev
ne pas utiliser apt, paquet outdated et localisation incompatible avec les themes additionnels
```shell
su
pip install mkdocs
mkdocs --version
# mkdocs, version 0.16.3
exit
```
localisation sur programme
```text
/usr/local/lib/python2.7/dist-packages/mkdocs
/usr/local/lib/python2.7/dist-packages/mkdocs/assets/search/mkdocs
/usr/local/lib/python2.7/dist-packages/mkdocs/themes/mkdocs
/usr/local/bin/mkdocs
/usr/share/mkdocs
```
installation d'un thème
```shell
pip install mkdocs-material
#localisation: /usr/local/lib/python2.7/dist-packages/material
```
pour info, création d'un nouveau site
```shell
mkdocs new kyopages
cd kyopages
# configurer git si besoin
```
construction manuelle
```shell
mkdocs build
# inutile si serveur en route, surveillance automatique des changements
# reconstruction, rafraîchissement du navigateur
```
organisation pages
```text
mkdocs.yml
docs/
autreDirectory/
autre.md
index.md
...
```
toutes la configuation, la déclaration des pages dans
```text
mkdocs.yml
```
démarrer serveur local, rafraîchissement automatique
```shell
mkdocs serve
```
lancer **firefox** avec http://localhost:8000
# liens en vrac
## GNU Privacy Guard (gpg)
* [Offciel](https://gnupg.org/documentation/guides.html)
* [Doc sympa rancoz](https://www.francoz.net/doc/gpg/gpg.html)
* [Doc sympa riseup](https://riseup.net/fr/security/message-security/openpgp/best-practices)
* [Ubuntu](https://doc.ubuntu-fr.org/gnupg)
* []()
#kyoPages
[liens en vrac](liens.md)
......@@ -6,16 +6,17 @@ site_author: kyodev
copyright: LPRAB/WTFPL
pages:
- Home: index.md
- Home: "index.md"
- Debian:
- Nettoyage: debian/nettoyage_debian.md
- Jessie en Stretch: debian/maj_jessie_stretch.md
- Nettoyage: "debian/nettoyage_debian.md"
- Jessie en Stretch: "debian/maj_jessie_stretch.md"
- Docs:
- live-build TP: docs/HOWTO-livebuild-stretch-TP.md
- docs/liens.md
- live-build TP: "docs/HOWTO-livebuild-stretch-TP.md"
- About:
- About: about/about.md
- Git: about/git.md
- License: about/LICENSE.md
- About: "about/about.md"
- Git: "about/git.md"
- License: "about/LICENSE.md"
markdown_extensions:
- extra
......
<!--
This Basic theme serves as an example for how to create other
themes by demonstrating the features with minimal HTML and CSS.
Comments like this will be through the code to explain briefly
what each feature is and point you to the MkDocs documentation
to find out more.
-->
<!DOCTYPE html>
<head>
<!--
The page_title contains the title for a page as shown in the navigation.
Site name contains the name as defined in the mkdocs.yml
-->
<title>{% if page_title %}{{ page_title }} - {% endif %}{{ site_name }}</title>
<!--
Support custom favicon support.
http://www.mkdocs.org/user-guide/configuration/#site_favicon
-->
{% if favicon %}
<link rel="shortcut icon" href="{{ favicon }}">
{% else %}
<link rel="shortcut icon" href="{{ base_url }}/img/favicon.ico">
{% endif %}
<!--
You can include external assets of course, but be aware that it means the
documentation may not work well offline.
-->
<!--
<link rel="stylesheet" href="https://yui-s.yahooapis.com/pure/0.6.0/pure-min.css">
-->
<link rel="stylesheet" href="{{ base_url }}/css/theme.css">
<!--
extra_ess contains paths to CSS files in the users
documentation directory or a list of CSS files defined in
their mkdocs.yml.
http://www.mkdocs.org/user-guide/configuration/#extra_css
-->
{% for path in extra_css %}
<link href="{{ path }}" rel="stylesheet">
{% endfor %}
<!--
To include static assets from our theme, just add
{{ base_url }} beforehand which will be the relative path to
the root of the documentation.
-->
<script src="{{ base_url }}/js/theme.js"></script>
<!--
extra_javascript contains paths to JavaScript files in the
users documentation directory or a list of JavaScript files
defined in their mkdocs.yml.
http://www.mkdocs.org/user-guide/configuration/#extra_javascript
-->
{% for path in extra_javascript %}
<script src="{{ path }}"></script>
{% endfor %}
<!--
Include Google Analytics tracking code.
http://www.mkdocs.org/user-guide/configuration/#google_analytics
-->
{% if google_analytics %}
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', '{{ google_analytics[0] }}', '{{ google_analytics[1] }}');
ga('send', 'pageview');
</script>
{% endif %}
{% block extrahead %}
{% endblock %}
</head>
<body>
<h1>This is an example theme for MkDocs.</h1>
<p>
It is designed to be read by looking at the theme HTML which is heavily
commented. The easiest way to do that is by
<strong><a href="https://github.com/mkdocs/mkdocs-basic-theme/tree/master/basic_theme">
looking at the source on GitHub.</a></strong>. Otherwise this is just a
demonstration that the theme is fully functional.
</p>
<hr/>
<h2>Documentation Navigation</h2>
<!--
Create the navigation for the documentation.
Because we don't know how many levels deep the navigation is, it needs to
be included in it's own file so it can be recursive. Otherwise the theme
can also only support a specific number of levels.
See the nav.html file for more details about how this works.
-->
<ul>
{% for nav_item in nav %}
{% include "nav.html" %}
{% endfor %}
</ul>
<hr/>
<h2>Support for search</h2>
<!--
Create a search form that sends the user to the search.html file - this is
the other file in the template which adds search to the theme. The only
requirement here is that there is a text input with the name 'q' and the
action and methods match below.
-->
<div role="search">
<form action="{{ base_url }}/search.html" method="get">
<input type="search" name="q" placeholder="Search docs" />
</form>
</div>
<hr/>
<h2>Next and previous links</h2>
<!--
Implement the previous and next links to cycle through the pages.
-->
{% if next_page or previous_page %}
<div>
{% if previous_page %}
<a href="{{ previous_page.url }}" title="{{ previous_page.title }}">&#8592; Previous Page</a>
{% else %}
&#8592; Previous Page
{% endif %}
-
{% if next_page %}
<a href="{{ next_page.url }}" title="{{ next_page.title }}"/>Next Page &#8594;</a>
{% else %}
Next Page &#8594;
{% endif %}
</div>
{% endif %}
<hr/>
<h2>Link to the source</h2>
<!--
Support repo URL
-->
{% if repo_url %}
{% if repo_name == 'GitHub' %}
<a href="{{ repo_url }}"> Edit on GitHub</a>
{% elif repo_name == 'Bitbucket' %}
<a href="{{ repo_url }}"> Edit on BitBucket</a>
{% else %}
<a href="{{ repo_url }}"> Edit in Repository</a>
{% endif %}
{% endif %}
<hr/>
<h2>Show the table of contents for the current page</h2>
<ul>
{% for toc_item in toc %}
<li><a href="{{ toc_item.url }}">{{ toc_item.title }}</a></li>
{% for toc_item in toc_item.children %}
<li><a href="{{ toc_item.url }}">{{ toc_item.title }}</a></li>
{% endfor %}
{% endfor %}
</ul>
<hr/>
{% block content %}
{{ content }}
{% endblock %}
<hr/>
<!--
Built with <a href="http://www.mkdocs.org">MkDocs</a>.
-->
<!--
MkDocs version : {{ mkdocs_version }}
Docs Build Date UTC : {{ build_date_utc }}
-->
</body>
</html>
body {
margin: 1em;
}
.active a {
color: red;
font-weight: bold;
}
/*
* This JavaScript doesn't do anything. The file exists just to demonstrate
* including static assets from the HTML in themes.
*/
<!--
-->
{% if not nav_item.children %}
<li {% if nav_item.active %}class="active"{% endif %}>
<a href="{{ nav_item.url }}">{{ nav_item.title }}</a>
</li>
{% else %}
<li>
{{ nav_item.title }}
<ul>
{% for nav_item in nav_item.children %}
{% include "nav.html" %}
{% endfor %}
</ul>
</li>
{% endif %}
{% extends "base.html" %}
{% block extrahead %}
<script>var base_url = '{{ base_url }}';</script>
<script data-main="{{ base_url }}/mkdocs/js/search.js" src="{{ base_url }}/mkdocs/js/require.js"></script>
{% endblock %}
{% block content %}
<h1 id="search">Search Results</h1>
<form id="content_search" action="search.html">
<span role="status" aria-live="polite" class="ui-helper-hidden-accessible"></span>
<input name="q" id="mkdocs-search-query" type="text" class="search_input search-query ui-autocomplete-input" placeholder="Search the Docs" autocomplete="off">
</form>
<div id="mkdocs-search-results">
Sorry, page not found.
</div>
{% endblock %}
# Testing Page
See the [Home Page](/). All the other pages are for demonstration purposes
with the navigation only.
# Testing Page
See the [Home Page](/). All the other pages are for demonstration purposes
with the navigation only.
# Testing Page
See the [Home Page](/). All the other pages are for demonstration purposes
with the navigation only.
# Testing Page
See the [Home Page](/). All the other pages are for demonstration purposes
with the navigation only.
# MkDocs Basic Theme
This is a very basic theme for MkDocs with the goal of demonstrating all of
the features with minimal HTML and CSS.
## Adapting this theme
If you want to use this theme as a base to create your own, it is best to
download or fork the theme and start to modify it
Make sure you read the MkDocs documentation regarding writing custom themes.
# Testing Page
See the [Home Page](/). All the other pages are for demonstration purposes
with the navigation only.
# Testing Page
See the [Home Page](/). All the other pages are for demonstration purposes
with the navigation only.
# Testing Page
See the [Home Page](/). All the other pages are for demonstration purposes
with the navigation only.
# Testing Page
See the [Home Page](/). All the other pages are for demonstration purposes
with the navigation only.
# Testing Page
See the [Home Page](/). All the other pages are for demonstration purposes
with the navigation only.
{% extends "base.html" %}
{% block content %}
<div class="row-fluid">
<div id="main-content" class="span12">
<h1 id="404-page-not-found" style="text-align: center">404</h1>
<p style="text-align: center"><strong>Page not found</strong></p>
</div>
</div>
{% endblock %}
<!DOCTYPE html>
<html lang="fr">
<head>
{%- block site_meta %}
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
{% if page and page.is_homepage %}<meta name="description" content="{{ config['site_description'] }}">{% endif %}
{% if config.site_author %}<meta name="author" content="{{ config.site_author }}">{% endif %}
{% if page and page.canonical_url %}<link rel="canonical" href="{{ page.canonical_url }}">{% endif %}
{% if config.site_favicon %}<link rel="shortcut icon" href="{{ base_url }}/{{ config.site_favicon }}">
{% else %}<link rel="shortcut icon" href="{{ base_url }}/img/favicon.ico">{% endif %}
{%- endblock %}
{%- block htmltitle %}
<title>{% if page and page.title and not page.is_homepage %}{{ page.title }} - {% endif %}{{ config.site_name }}</title>
{%- endblock %}
{%- block styles %}
<link href="{{ base_url }}/css/bootstrap-custom.min.css" rel="stylesheet">
<link href="{{ base_url }}/css/font-awesome-4.5.0.css" rel="stylesheet">
<link href="{{ base_url }}/css/base.css" rel="stylesheet">
<link rel="stylesheet" href="{{ base_url }}/css/highlight.css">
{%- for path in extra_css %}
<link href="{{ path }}" rel="stylesheet">
{%- endfor %}
{%- endblock %}
{%- block libs %}
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
<script src="{{ base_url }}/js/jquery-1.10.2.min.js"></script>
<script src="{{ base_url }}/js/bootstrap-3.0.3.min.js"></script>
<script src="{{ base_url }}/js/highlight.pack.js"></script>
{%- endblock %}
{%- block analytics %}
{%- if config.google_analytics %}
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', '{{ config.google_analytics[0] }}', '{{ config.google_analytics[1] }}');
ga('send', 'pageview');
</script>
{%- endif %}
{%- endblock %}
{%- block extrahead %} {% endblock %}
</head>
<body{% if page and page.is_homepage %} class="homepage"{% endif %}>
{% include "nav.html" %}
<div class="container">
{%- block content %}
<div class="col-md-3">{% include "toc.html" %}</div>
<div class="col-md-9" role="main">{% include "content.html" %}</div>
{%- endblock %}
</div>
<footer class="col-md-12">
{%- block footer %}
<hr>
{%- if config.copyright %}
<p> kyoPages - license {{ config.copyright }}</p>
{%- endif %}
<!-- <p>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</p> -->
{%- endblock %}
</footer>
{%- block scripts %}
<script>var base_url = '{{ base_url }}';</script>
<script data-main="{{ base_url }}/mkdocs/js/search.js" src="{{ base_url }}/mkdocs/js/require.js"></script>
<script src="{{ base_url }}/js/base.js"></script>
{%- for path in extra_javascript %}
<script src="{{ path }}"></script>
{%- endfor %}
{%- endblock %}
{%- include "search-modal.html" %}
</body>
</html>
{% if page and page.is_homepage %}
<!--
MkDocs version : {{ mkdocs_version }}
Build Date UTC : {{ build_date_utc }}
-->
{% endif %}
{% if page.meta.source %}
<div class="source-links">
{% for filename in page.meta.source %}
<span class="label label-primary">{{ filename }}</span>
{% endfor %}
</div>
{% endif %}
{{ page.content }}
body {
padding-top: 70px;
background: url(../img/grid.png) repeat-x;
background-attachment: fixed;
background-color: #f8f8f8;
}
body > .container {
min-height: 400px;
}
ul.nav .main {
font-weight: bold;
}
.col-md-3 {
padding-left: 0;
}
.col-md-9 {
padding-bottom: 100px;
}
.source-links {
float: right;
}
.col-md-9 img {
max-width: 100%;
display: inline-block;
padding: 4px;
line-height: 1.428571429;
background-color: #fff;
border: 1px solid #ddd;
border-radius: 4px;
margin: 20px auto 30px auto;
}
/*
* The code below adds some padding to the top of the current anchor target so
* that, when navigating to it, the header isn't hidden by the navbar at the
* top. This is especially complicated because we want to *remove* the padding
* after navigation so that hovering over the header shows the permalink icon
* correctly. Thus, we create a CSS animation to remove the extra padding after
* a second. We have two animations so that navigating to an anchor within the
* page always restarts the animation.
*
* See <https://github.com/mkdocs/mkdocs/issues/843> for more details.
*/
:target::before {
content: "";
display: block;
margin-top: -75px;
height: 75px;
pointer-events: none;
animation: 0s 1s forwards collapse-anchor-padding-1;
}
.clicky :target::before {
animation-name: collapse-anchor-padding-2;
}
@keyframes collapse-anchor-padding-1 {
to {
margin-top: 0;
height: 0;
}
}
@keyframes collapse-anchor-padding-2 {
to {
margin-top: 0;
height: 0;
}
}
h1 {
color: #444;
font-weight: 400;
font-size: 42px;
}
h2, h3, h4, h5, h6 {
color: #444;
font-weight: 300;
}
hr {
border-top: 1px solid #aaa;
}
pre, .rst-content tt {
max-width: 100%;
background: #fff;
border: solid 1px #e1e4e5;
color: #333;
overflow-x: auto;
}
code.code-large, .rst-content tt.code-large {
font-size: 90%;
}
code {
padding: 2px 5px;
background: #fff;
border: solid 1px #e1e4e5;
color: #333;
white-space: pre-wrap;
word-wrap: break-word;
}
pre code {
background: transparent;
border: none;
white-space: pre;
word-wrap: normal;
font-family: monospace,serif;
font-size: 12px;
}
a code {
color: #2FA4E7;
}
a:hover code, a:focus code {
color: #157AB5;
}
footer {
margin-top: 30px;
margin-bottom: 10px;
text-align: center;
font-weight: 200;
}
.modal-dialog {
margin-top: 60px;
}
/*
* Side navigation
*
* Scrollspy and affixed enhanced navigation to highlight sections and secondary
* sections of docs content.
*/
/* By default it's not affixed in mobile views, so undo that */
.bs-sidebar.affix { /* csslint allow: adjoining-classes */
position: static;
}
.bs-sidebar.well { /* csslint allow: adjoining-classes */
padding: 0;
max-height: 90%;
overflow-y: auto;
}
/* First level of nav */
.bs-sidenav {
padding-top: 10px;
padding-bottom: 10px;
border-radius: 5px;
}
/* All levels of nav */
.bs-sidebar .nav > li > a {
display: block;
padding: 5px 20px;
z-index: 1;
}
.bs-sidebar .nav > li > a:hover,
.bs-sidebar .nav > li > a:focus {
text-decoration: none;
border-right: 1px solid;
}
.bs-sidebar .nav > .active > a,
.bs-sidebar .nav > .active:hover > a,
.bs-sidebar .nav > .active:focus > a {
font-weight: bold;
background-color: transparent;
border-right: 1px solid;