init commit Docs via mkdocs with bootstrap theme

algobet · May 8, 2017 · 36f5fbe · 36f5fbe
commit 36f5fbe
Show file tree

Hide file tree

Showing 23 changed files with 2,266 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+*.pyc
+dist/
+site/
diff --git a/README.md b/README.md
@@ -0,0 +1,4 @@
+# Fanily Docs
+
+Fanily Docs via mkdocs with bootstrap theme.
+
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,12 @@
+# The Fanily Group
+
+The Fanily is a cluster of biographical websites.
+
+## AF
+
+
+
+## CC
+
+
+## IF
diff --git a/docs/isaac.md b/docs/isaac.md
@@ -0,0 +1,10 @@
+# Isaac
+
+## Activites
+
+
+## Moments
+
+
+## Contact
+
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,14 @@
+site_name: Fanily
+site_url: http://fanily.algobet.xyz/
+site_description: Fanily Group
+site_author: The Fanily
+
+repo_url: https://github.com/algobet/fanily.clover
+
+pages:
+  - Home: index.md
+  - Isaac: isaac.md
+
+copyright: Copyright &copy; 2017 <a href="https://twitter.com/algobet_xyz">algobet&trade; concept</a>
+
+theme_dir: mkdocs_bootstrap
diff --git a/mkdocs_bootstrap/base.html b/mkdocs_bootstrap/base.html
@@ -0,0 +1,85 @@
+<!DOCTYPE html>
+<html lang="en">
+    <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 config.site_description %}<meta name="description" content="{{ config.site_description }}">{% endif %}
+        {% if config.site_author %}<meta name="author" content="{{ config.site_author }}">{% endif %}
+        {% if page.canonical_url %}<link rel="canonical" href="{{ page.canonical_url }}">{% endif %}
+        <link rel="shortcut icon" href="{{ base_url }}/img/favicon.ico">
+        {%- endblock %}
+
+        {%- block htmltitle %}
+        <title>{% if page and page.title %}{{ page.title }} - {% endif %}{{ config.site_name }}</title>
+        {%- endblock %}
+
+        {%- block styles %}
+        <link href="{{ base_url }}/css/bootstrap-3.3.7.min.css" rel="stylesheet">
+        <link href="{{ base_url }}/css/font-awesome-4.0.3.css" rel="stylesheet">
+        <link rel="stylesheet" href="{{ base_url }}/css/highlight.css">
+        <link href="{{ base_url }}/css/base.css" rel="stylesheet">
+        {%- 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.3/html5shiv.js"></script>
+            <script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
+        <![endif]-->
+
+        <script src="{{ base_url }}/js/jquery-1.10.2.min.js"></script>
+        <script src="{{ base_url }}/js/bootstrap-3.3.7.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>
+
+        {% 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 %}
+        <center>{{ config.copyright }}</center>
+        {% endif %}
+        <center>Docs issued by <a href="http://www.algobet.org/">algobet Labs</a>.</center>
+        {%- endblock %}
+    </footer>
+
+        {%- block scripts %}
+        <script src="{{ base_url }}/js/base.js"></script>
+        {%- for path in extra_javascript %}
+        <script src="{{ path }}"></script>
+        {%- endfor %}
+        {%- endblock %}
+    </body>
+</html>
diff --git a/mkdocs_bootstrap/content.html b/mkdocs_bootstrap/content.html
@@ -0,0 +1,9 @@
+{% if page and page.meta and page.meta.source %}
+<div class="source-links">
+{% for filename in page.meta.source %}
+    <span class="label label-primary">{{ filename }}</span>
+{% endfor %}
+</div>
+{% endif %}
+
+{% if page and page.content %}{{ page.content }}{% endif %}
diff --git a/mkdocs_bootstrap/css/base.css b/mkdocs_bootstrap/css/base.css
@@ -0,0 +1,117 @@
+body {
+    padding-top: 70px;
+}
+
+h1[id]:before, h2[id]:before, h3[id]:before, h4[id]:before, h5[id]:before, h6[id]:before {
+    content: "";
+    display: block;
+    margin-top: -75px;
+    height: 75px;
+}
+
+ul.nav li.main {
+    font-weight: bold;
+}
+
+div.col-md-3 {
+    padding-left: 0;
+}
+
+div.col-md-9 {
+    padding-bottom: 100px;
+}
+
+div.source-links {
+    float: right;
+}
+
+div.col-md-9 img {
+  max-width: 100%;
+}
+
+/*
+ * 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 {
+    position: static;
+}
+
+.bs-sidebar.well {
+    padding: 0;
+}
+
+/* First level of nav */
+.bs-sidenav {
+    margin-top: 30px;
+    margin-bottom: 30px;
+    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) {
+    .bs-sidebar .nav > .active > ul {
+        display: block;
+    }
+    /* Widen the fixed sidebar */
+    .bs-sidebar.affix,
+    .bs-sidebar.affix-bottom {
+        width: 213px;
+    }
+    .bs-sidebar.affix {
+        position: fixed; /* Undo the static from mobile first approach */
+        top: 80px;
+    }
+    .bs-sidebar.affix-bottom {
+        position: absolute; /* Undo the static from mobile first approach */
+    }
+    .bs-sidebar.affix-bottom .bs-sidenav,
+    .bs-sidebar.affix .bs-sidenav {
+        margin-top: 0;
+        margin-bottom: 0;
+    }
+}
+@media (min-width: 1200px) {
+    /* Widen the fixed sidebar again */
+    .bs-sidebar.affix-bottom,
+    .bs-sidebar.affix {
+        width: 263px;
+    }
+}
diff --git a/mkdocs_bootstrap/css/bootstrap-3.3.7.min.css b/mkdocs_bootstrap/css/bootstrap-3.3.7.min.css