Initial commit

9acac4c0 · erdnaxe · 9acac4c0 · 9acac4c0 · 9acac4c0 · 9acac4c0
Verified Commit 9acac4c0 authored Dec 08, 2019 by erdnaxe 🦋
--- a/.gitignore
+++ b/.gitignore
+# Build files
+site/
+
+# Do not lock deps
+Pipfile.lock
--- a/LICENSE
+++ b/LICENSE
--- a/Pipfile
+++ b/Pipfile
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+
+[packages]
+mkdocs = "*"
+
+[requires]
+python_version = "3.6"
--- a/README.md
+++ b/README.md
+# Documentation de démarrage
+
+Site statique minimaliste pour aiguiller un nouvel utilisateur.
+
+## Compiler la documentation chez soi
+
+Il faut installer `mkdocs`.
+Ensuite dans le dossier vous pouvez simplement appeler `mkdocs serve`.
+
+Pour simplifier le travail, vous pouvez juste utiliser Pipenv.
+
+```
+pipenv install
+pipenv run mkdocs serve
+```
+
--- a/custom_theme/404.html
+++ b/custom_theme/404.html
+{% 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 non trouvée ✿</strong><br/>
+            Si vous venez de suivre un lien menant ici ou si vous estimez que cette page devrait exister,<br/>
+            merci de nous le signaler et nous mettrons une équipe de pingouins au travail. 
+        </p>
+      </div>
+    </div>
+
+{% endblock %}
--- a/custom_theme/base.html
+++ b/custom_theme/base.html
+<!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="{{ config.site_favicon|url }}">
+        {% else %}<link rel="shortcut icon" href="{{ 'img/favicon.ico'|url }}">{% 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="{{ 'css/bootstrap-custom.min.css'|url }}" rel="stylesheet">
+        <link href="{{ 'css/font-awesome.min.css'|url }}" rel="stylesheet">
+        <link href="{{ 'css/base.css'|url }}" rel="stylesheet">
+        {%- if config.theme.highlightjs %}
+        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/{{ config.theme.hljs_style }}.min.css">
+        {%- endif %}
+        {%- for path in config['extra_css'] %}
+        <link href="{{ path|url }}" 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.4.2/respond.min.js"></script>
+        <![endif]-->
+
+        <script src="{{ 'js/jquery-1.10.2.min.js'|url }}" defer></script>
+        <script src="{{ 'js/bootstrap-3.0.3.min.js'|url }}" defer></script>
+        {%- if config.theme.highlightjs %}
+        <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
+        {%- for lang in config.theme.hljs_languages %}
+        <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/{{lang}}.min.js"></script>
+        {%- endfor %}
+        <script>hljs.initHighlightingOnLoad();</script>
+        {%- endif %}
+      {%- 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','https://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 %}>
+
+        <div class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+            <div class="container">
+
+                <!-- Collapsed navigation -->
+                <div class="navbar-header">
+                    {%- if nav|length>1 or (page and (page.next_page or page.previous_page)) or config.repo_url %}
+                    <!-- Expander button -->
+                    <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+                        <span class="sr-only">Toggle navigation</span>
+                        <span class="icon-bar"></span>
+                        <span class="icon-bar"></span>
+                        <span class="icon-bar"></span>
+                    </button>
+                    {%- endif %}
+
+                  {%- block site_name %}
+                    <a class="navbar-brand" href="{{ nav.homepage.url|url }}">
+                        <img src="/img/logo.png" alt="Cr@ns">
+                    </a>
+                  {%- endblock %}
+                </div>
+
+                <!-- Expanded navigation -->
+                <div class="navbar-collapse collapse">
+                  {%- block site_nav %}
+                    <!-- Main navigation -->
+                    <ul class="nav navbar-nav navbar-right">
+                    {%- for nav_item in nav %}
+                    {%- if nav_item.children %}
+                        <li class="dropdown{% if nav_item.active %} active{% endif %}">
+                            <a href="#" class="dropdown-toggle" data-toggle="dropdown">{{ nav_item.title }} <b class="caret"></b></a>
+                            <ul class="dropdown-menu">
+                            {%- for nav_item in nav_item.children %}
+                                {% include "nav-sub.html" %}
+                            {%- endfor %}
+                            </ul>
+                        </li>
+                    {%- else %}
+                        <li {% if nav_item.active %}class="active"{% endif %}>
+                            <a href="{{ nav_item.url|url }}">{{ nav_item.title }}</a>
+                        </li>
+                    {%- endif %}
+                    {%- endfor %}
+                    {%- block search_button %}
+                        {%- if 'search' in config['plugins'] %}
+                        <li>
+                            <a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
+                                <i class="fa fa-search"></i> Recherche
+                            </a>
+                        </li>
+                        {%- endif %}
+                      {%- endblock %}
+                    </ul>
+                  {%- endblock %}
+                </div>
+            </div>
+        </div>
+
+        <div class="container">
+            {%- block content %}
+                <div class="col-md-3 hidden-sm hidden-xs">{% include "toc.html" %}</div>
+                <div class="col-md-9" role="main">{% include "content.html" %}</div>
+            {%- endblock %}
+        </div>
+
+        <footer class="col-md-12">
+          {%- block footer %}
+            {%- if config.copyright %}
+                <p>{{ config.copyright }}</p>
+            {%- endif %}
+          {%- endblock %}
+        </footer>
+
+      {%- block scripts %}
+        <script>
+            var base_url = {{ base_url | tojson }},
+                shortcuts = {{ config.theme.shortcuts | tojson }};
+        </script>
+        <script src="{{ 'js/base.js'|url }}" defer></script>
+        {%- for path in config['extra_javascript'] %}
+        <script src="{{ path|url }}" defer></script>
+        {%- endfor %}
+      {%- endblock %}
+
+        {% if 'search' in config['plugins'] %}{%- include "search-modal.html" %}{% endif %}
+        {%- include "keyboard-modal.html" %}
+
+    </body>
+</html>
+{% if page and page.is_homepage %}
+<!--
+MkDocs version : {{ mkdocs_version }}
+Build Date UTC : {{ build_date_utc }}
+-->
+{% endif %}
--- a/custom_theme/css/base.css
+++ b/custom_theme/css/base.css
+body {
+    padding-top: 70px;
+}
+
+/* Replacement for `body { background-attachment: fixed; }`, which has
+   performance issues when scrolling on large displays. See #1394. */
+body::before {
+    content: ' ';
+    position: fixed;
+    width: 100%;
+    height: 100%;
+    top: 0;
+    left: 0;
+    background: url(../img/grid.png) repeat-x;
+    will-change: transform;
+    z-index: -1;
+}
+
+body > .container {
+    min-height: 400px;
+}
+
+ul.nav .main {
+    font-weight: bold;
+}
+
+.col-md-3 {
+    padding-left: 0;
+    z-index: 1;
+}
+
+.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.
+ */
+:target::before {
+    content: "";
+    display: block;
+    margin-top: -75px;
+    height: 75px;
+    pointer-events: none;
+}
+
+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;
+}
+
+kbd {
+    padding: 2px 4px;
+    font-size: 90%;
+    color: #fff;
+    background-color: #333;
+    border-radius: 3px;
+    -webkit-box-shadow: inset 0 -1px 0 rgba(0,0,0,.25);
+    box-shadow: inset 0 -1px 0 rgba(0,0,0,.25);
+}
+
+a code {
+    color: #2FA4E7;
+}
+
+a:hover code, a:focus code {
+    color: #157AB5;
+}
+
+footer {
+    margin-top: 0;
+    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;
+}
+
+/* Nav: second level (shown on .active) */
+.bs-sidebar .nav .nav {
+    display: none; /* Hide by default, but at >768px, show it */
+    margin-bottom: 8px;
+}
+.bs-sidebar .nav .nav > li > a {
+    padding-top:    3px;
+    padding-bottom: 3px;
+    padding-left: 30px;
+    font-size: 90%;
+}
+
+/* Show and affix the side nav when space allows it */
+@media (min-width: 992px) {
+    /* Workaround a Safari bug when zooming to < 100%
+       https://github.com/mkdocs/mkdocs/issues/1050 */
+    .col-md-9 {
+        box-sizing: border-box;  /* csslint allow: box-sizing */
+        padding-left: 25%;
+        width: 100%;
+    }
+    .bs-sidebar .nav > .active > ul {
+        display: block;
+    }
+    /* Widen the fixed sidebar */
+    .bs-sidebar.affix, /* csslint allow: adjoining-classes */
+    .bs-sidebar.affix-bottom { /* csslint allow: adjoining-classes */
+        width: 213px;
+    }
+    .bs-sidebar.affix { /* csslint allow: adjoining-classes */
+        position: fixed; /* Undo the static from mobile first approach */
+        top: 80px;
+    }
+    .bs-sidebar.affix-bottom { /* csslint allow: adjoining-classes */
+        position: absolute; /* Undo the static from mobile first approach */
+    }
+    .bs-sidebar.affix-bottom .bs-sidenav, /* csslint allow: adjoining-classes */
+    .bs-sidebar.affix .bs-sidenav { /* csslint allow: adjoining-classes */
+        margin-top: 0;
+        margin-bottom: 0;
+    }
+}
+@media (min-width: 1200px) {
+    /* Widen the fixed sidebar again */
+    .bs-sidebar.affix-bottom, /* csslint allow: adjoining-classes */
+    .bs-sidebar.affix { /* csslint allow: adjoining-classes */
+        width: 263px;
+    }
+}
+
+.headerlink {
+    font-family: FontAwesome;
+    font-size: 14px;
+    display: none;
+    padding-left: .5em;
+}
+
+h1:hover .headerlink, h2:hover .headerlink, h3:hover .headerlink, h4:hover .headerlink, h5:hover .headerlink, h6:hover .headerlink{
+    display:inline-block;
+}
+
+
+
+.admonition {
+    padding: 15px;
+    margin-bottom: 20px;
+    border: 1px solid transparent;
+    border-radius: 4px;
+    text-align: left;
+}
+
+.admonition.note { /* csslint allow: adjoining-classes */
+    color: #3a87ad;
+    background-color: #d9edf7;
+    border-color: #bce8f1;
+}
+
+.admonition.warning { /* csslint allow: adjoining-classes */
+    color: #c09853;
+    background-color: #fcf8e3;
+    border-color: #fbeed5;
+}
+
+.admonition.danger { /* csslint allow: adjoining-classes */
+    color: #b94a48;
+    background-color: #f2dede;
+    border-color: #eed3d7;
+}
+
+.admonition-title {
+    font-weight: bold;
+    text-align: left;
+}
+
+
+.dropdown-submenu {
+    position: relative;
+}
+
+.dropdown-submenu>.dropdown-menu {
+    top: 0;
+    left: 100%;
+    margin-top: -6px;
+    margin-left: -1px;
+    -webkit-border-radius: 0 6px 6px 6px;
+    -moz-border-radius: 0 6px 6px;
+    border-radius: 0 6px 6px 6px;
+}
+
+.dropdown-submenu:hover>.dropdown-menu {
+    display: block;
+}
+
+.dropdown-submenu>a:after {
+    display: block;
+    content: " ";
+    float: right;
+    width: 0;
+    height: 0;
+    border-color: transparent;
+    border-style: solid;
+    border-width: 5px 0 5px 5px;
+    border-left-color: #ccc;
+    margin-top: 5px;
+    margin-right: -10px;
+}
+
+.dropdown-submenu:hover>a:after {
+    border-left-color: #fff;
+}
+
+.dropdown-submenu.pull-left { /* csslint allow: adjoining-classes */
+    float: none;
+}
+
+.dropdown-submenu.pull-left>.dropdown-menu { /* csslint allow: adjoining-classes */
+    left: -100%;
+    margin-left: 10px;
+    -webkit-border-radius: 6px 0 6px 6px;
+    -moz-border-radius: 6px 0 6px 6px;
+    border-radius: 6px 0 6px 6px;
+}
+
+/* Custom Crans Navbar */
+.navbar {
+    background-color: #222 !important;
+    border-color: #d31a22 !important;
+    background-image: none !important;
+}
+.navbar-inverse .navbar-brand {
+    color: white !important;
+}
+.navbar-inverse .navbar-nav>li>a {
+    color: white !important;
+}
+.navbar-brand {
+    padding: 5px 30px;
+}
+.navbar-brand img {
+    height: 40px;
+}
+.navbar-inverse .navbar-nav > .active > a,
+.navbar-inverse .navbar-nav > .active > a:hover,
+.navbar-inverse .navbar-nav > .active > a:focus,
+.navbar-inverse .navbar-nav > li > a:hover,
+.navbar-inverse .navbar-nav > li > a:focus {
+    color: #fff;
+    background-color: #000000;
+}
+
--- a/custom_theme/img/favicon.ico
+++ b/custom_theme/img/favicon.ico
--- a/custom_theme/img/logo.png
+++ b/custom_theme/img/logo.png
--- a/custom_theme/search-modal.html
+++ b/custom_theme/search-modal.html
+<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
+    <div class="modal-dialog">
+        <div class="modal-content">
+            <div class="modal-header">
+                <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Fermer</span></button>
+                <h4 class="modal-title" id="exampleModalLabel">Recherche</h4>
+            </div>
+            <div class="modal-body">
+                <p>
+                    À partir d'ici, vous pouvez chercher dans tout ce site.
+                    Entrez les termes de recherche ci-dessous.
+                </p>
+                <form role="form">
+                    <div class="form-group">
+                        <input type="text" class="form-control" id="mkdocs-search-query" title="Entrez les termes ici">
+                    </div>
+                </form>
+                <div id="mkdocs-search-results"></div>
+            </div>
+        </div>
+    </div>
+</div>
--- a/docs/index.md
+++ b/docs/index.md
+# Bienvenue au Cr@ns
+
+## Qui sommes nous ?
+
+Le Cr@ns est une association gérée par des bénévoles étudiants, qui a pour
+mission de fournir une couverture internet filaire et WiFi très haut débit
+aux élèves du campus de l'ENS Paris-Saclay pour 50€ par an.
+L'association fournit également à ses adhérents des services tels
+qu'une boîte mail, un hébergement de pages personnelles, la télévision...
+
+## Une question, un problème ?
+
+Nouvel arrivant ou ancien adhérent, tu trouveras probablement la solution à ton
+problème dans [la foire aux questions](faq).
+Sinon, n'hésite pas à nous [contacter](contact).
+
+## Je veux aider !
+
+Si tu as envie de découvrir l'envers du décor, que ce soit la gestion
+administrative d'une association à grande échelle ou la gestion technique
+de l'infrastructure, tu es le/la bienvenu(e). Il n'y a pas de connaissance
+particulière à avoir pour commencer, mais si tu nous rejoins, tu auras
+l'occasion d'en acquérir de nombreuses. Pour commencer, le plus simple est
+de prendre contact avec nous, par exemple en nous croisant à la Kfet pendant
+une permanence. À bientôt !
+
--- a/mkdocs.yml
+++ b/mkdocs.yml