├── LICENSE
├── README.md
├── cookiecutter.json
└── {{cookiecutter.repo_name}}
    ├── .gitignore
    ├── LICENSE
    ├── MANIFEST.in
    ├── docs
        └── index.md
    ├── mkdocs.yml
    ├── setup.py
    └── {{cookiecutter.repo_name}}
        ├── __init__.py
        ├── base.html
        ├── css
            └── theme.css
        ├── js
            └── theme.js
        ├── nav.html
        └── search.html


/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright © 2016, Dougal Matthews. All rights reserved.
 2 | 
 3 | Redistribution and use in source and binary forms, with or
 4 | without modification, are permitted provided that the following
 5 | conditions are met:
 6 | 
 7 | Redistributions of source code must retain the above copyright
 8 | notice, this list of conditions and the following disclaimer.
 9 | Redistributions in binary form must reproduce the above copyright
10 | notice, this list of conditions and the following disclaimer in
11 | the documentation and/or other materials provided with the
12 | distribution.
13 | 
14 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
15 | CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
16 | INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
17 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
19 | CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 | LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
22 | USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 | AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25 | ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 | POSSIBILITY OF SUCH DAMAGE.
27 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # MkDocs Theme Template
 2 | 
 3 | Basic [Cookiecutter](https://cookiecutter.rtfd.org) template for
 4 | MkDocs themes.
 5 | 
 6 | # Usage
 7 | 
 8 | Create a new theme with:
 9 | 
10 |     cookiecutter gh:mkdocs/theme-template
11 | 


--------------------------------------------------------------------------------
/cookiecutter.json:
--------------------------------------------------------------------------------
1 | {
2 |     "email": "dougal@dougalmatthews.com",
3 |     "full_name": "Dougal Matthews",
4 |     "repo_name": "theme_name",
5 |     "repo_url": "http://theme-url.com",
6 |     "theme_name": "my_mkdocs_theme",
7 |     "year": "2016"
8 | }
9 | 


--------------------------------------------------------------------------------
/{{cookiecutter.repo_name}}/.gitignore:
--------------------------------------------------------------------------------
1 | *.pyc
2 | dist/
3 | *.egg-info/
4 | site/
5 | 


--------------------------------------------------------------------------------
/{{cookiecutter.repo_name}}/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright © {{cookiecutter.full_name}}, {{cookiecutter.full_name}}. All rights reserved.
 2 | 
 3 | Redistribution and use in source and binary forms, with or
 4 | without modification, are permitted provided that the following
 5 | conditions are met:
 6 | 
 7 | Redistributions of source code must retain the above copyright
 8 | notice, this list of conditions and the following disclaimer.
 9 | Redistributions in binary form must reproduce the above copyright
10 | notice, this list of conditions and the following disclaimer in
11 | the documentation and/or other materials provided with the
12 | distribution.
13 | 
14 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
15 | CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
16 | INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
17 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
19 | CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 | LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
22 | USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 | AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25 | ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 | POSSIBILITY OF SUCH DAMAGE.
27 | 


--------------------------------------------------------------------------------
/{{cookiecutter.repo_name}}/MANIFEST.in:
--------------------------------------------------------------------------------
1 | recursive-include {{cookiecutter.repo_name}} *.ico *.js *.css *.png *.html *.eot *.svg *.ttf *.woff
2 | recursive-exclude * __pycache__
3 | recursive-exclude * *.py[co]
4 | 


--------------------------------------------------------------------------------
/{{cookiecutter.repo_name}}/docs/index.md:
--------------------------------------------------------------------------------
1 | # {{cookiecutter.theme_name}}
2 | 
3 | 


--------------------------------------------------------------------------------
/{{cookiecutter.repo_name}}/mkdocs.yml:
--------------------------------------------------------------------------------
1 | site_name: {{cookiecutter.theme_name}} - MkDocs Theme
2 | theme_dir: {{cookiecutter.repo_name}}
3 | 
4 | repo_url: {{cookiecutter.repo_url}}
5 | 


--------------------------------------------------------------------------------
/{{cookiecutter.repo_name}}/setup.py:
--------------------------------------------------------------------------------
 1 | from setuptools import setup, find_packages
 2 | 
 3 | VERSION = '0.0.1'
 4 | 
 5 | 
 6 | setup(
 7 |     name="{{cookiecutter.repo_name}}",
 8 |     version=VERSION,
 9 |     url='{{cookiecutter.repo_url}}',
10 |     license='BSD',
11 |     description='Minimal theme for MkDocs',
12 |     author='{{cookiecutter.full_name}}',
13 |     author_email='{{cookiecutter.email}}',
14 |     packages=find_packages(),
15 |     include_package_data=True,
16 |     entry_points={
17 |         'mkdocs.themes': [
18 |             '{{cookiecutter.repo_name}} = {{cookiecutter.repo_name}}',
19 |         ]
20 |     },
21 |     zip_safe=False
22 | )
23 | 


--------------------------------------------------------------------------------
/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mkdocs/theme-template/9ab09300ce1848ce08b4da6e674dee7b977ad320/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/__init__.py


--------------------------------------------------------------------------------
/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/base.html:
--------------------------------------------------------------------------------
  1 | {% raw %}<!--
  2 |   This Basic theme serves as an example for how to create other
  3 |   themes by demonstrating the features with minimal HTML and CSS.
  4 |   Comments like this will be through the code to explain briefly
  5 |   what each feature is and point you to the MkDocs documentation
  6 |   to find out more.
  7 | -->
  8 | <!DOCTYPE html>
  9 | <head>
 10 | 
 11 |   <!--
 12 |     The page_title contains the title for a page as shown in the navigation.
 13 |     Site name contains the name as defined in the mkdocs.yml
 14 |   -->
 15 |   <title>{% if page_title %}{{ page_title }} - {% endif %}{{ site_name }}</title>
 16 | 
 17 |   <!--
 18 |     Support custom favicon support.
 19 |     http://www.mkdocs.org/user-guide/configuration/#site_favicon
 20 |   -->
 21 |   {% if favicon %}
 22 |     <link rel="shortcut icon" href="{{ favicon }}">
 23 |   {% else %}
 24 |     <link rel="shortcut icon" href="{{ base_url }}/img/favicon.ico">
 25 |   {% endif %}
 26 | 
 27 |   <!--
 28 |     You can include external assets of course, but be aware that it means the
 29 |     documentation may not work well offline.
 30 |   -->
 31 |   <link rel="stylesheet" href="https://yui-s.yahooapis.com/pure/0.6.0/pure-min.css">
 32 | 
 33 |   <link rel="stylesheet" href="{{ base_url }}/css/theme.css">
 34 | 
 35 |   <!--
 36 |     extra_ess contains paths to CSS files in the users
 37 |     documentation directory or a list of CSS files defined in
 38 |     their mkdocs.yml.
 39 | 
 40 |     http://www.mkdocs.org/user-guide/configuration/#extra_css
 41 |   -->
 42 |   {% for path in extra_css %}
 43 |     <link href="{{ path }}" rel="stylesheet">
 44 |   {% endfor %}
 45 | 
 46 |   <!--
 47 |     To include static assets from our theme, just add
 48 |     {{ base_url }} beforehand which will be the relative path to
 49 |     the root of the documentation.
 50 |   -->
 51 |   <script src="{{ base_url }}/js/theme.js"></script>
 52 | 
 53 |   <!--
 54 |     extra_javascript contains paths to JavaScript files in the
 55 |     users documentation directory or a list of JavaScript files
 56 |     defined in their mkdocs.yml.
 57 | 
 58 |     http://www.mkdocs.org/user-guide/configuration/#extra_javascript
 59 |   -->
 60 |   {% for path in extra_javascript %}
 61 |     <script src="{{ path }}"></script>
 62 |   {% endfor %}
 63 | 
 64 |   <!--
 65 |     Include Google Analytics tracking code.
 66 | 
 67 |     http://www.mkdocs.org/user-guide/configuration/#google_analytics
 68 |   -->
 69 |   {% if google_analytics %}
 70 |   <script>
 71 |       (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
 72 |       (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
 73 |       m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
 74 |       })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
 75 | 
 76 |       ga('create', '{{ google_analytics[0] }}', '{{ google_analytics[1] }}');
 77 |       ga('send', 'pageview');
 78 |   </script>
 79 |   {% endif %}
 80 | 
 81 |   {% block extrahead %}
 82 |   {% endblock %}
 83 | </head>
 84 | 
 85 | <body>
 86 | 
 87 |   <h1>This is an example theme for MkDocs.</h1>
 88 | 
 89 |   <p>
 90 |     It is designed to be read by looking at the theme HTML which is heavily
 91 |     commented. The easiest way to do that is by
 92 |     <strong><a href="https://github.com/mkdocs/mkdocs-basic-theme/tree/master/basic_theme">
 93 |     looking at the source on GitHub.</a></strong>. Otherwise this is just a
 94 |     demonstration that the theme is fully functional.
 95 |   </p>
 96 | 
 97 |   <hr/>
 98 | 
 99 |   <h2>Documentation Navigation</h2>
100 | 
101 |   <!--
102 |     Create the navigation for the documentation.
103 | 
104 |     Because we don't know how many levels deep the navigation is, it needs to
105 |     be included in it's own file so it can be recursive. Otherwise the theme
106 |     can also only support a specific number of levels.
107 | 
108 |     See the nav.html file for more details about how this works.
109 |   -->
110 |   <ul>
111 |   {% for nav_item in nav %}
112 |     {% include "nav.html" %}
113 |   {% endfor %}
114 |   </ul>
115 | 
116 |   <hr/>
117 | 
118 |   <h2>Support for search</h2>
119 |   <!--
120 |     Create a search form that sends the user to the search.html file - this is
121 |     the other file in the template which adds search to the theme. The only
122 |     requirement here is that there is a text input with the name 'q' and the
123 |     action and methods match below.
124 |   -->
125 |   <div role="search">
126 |     <form action="{{ base_url }}/search.html" method="get">
127 |       <input type="text" name="q" placeholder="Search docs" />
128 |     </form>
129 |   </div>
130 | 
131 |   <hr/>
132 | 
133 |   <h2>Next and previous links</h2>
134 |   <!--
135 |     Implement the previous and next links to cycle through the pages.
136 |   -->
137 |   {% if next_page or previous_page %}
138 |     <div>
139 |       {% if previous_page %}
140 |         <a href="{{ previous_page.url }}" title="{{ previous_page.title }}">&#8592; Previous Page</a>
141 |       {% else %}
142 |         &#8592; Previous Page
143 |       {% endif %}
144 |       -
145 |       {% if next_page %}
146 |         <a href="{{ next_page.url }}" title="{{ next_page.title }}"/>Next Page &#8594;</a>
147 |       {% else %}
148 |         Next Page &#8594;
149 |       {% endif %}
150 |     </div>
151 |   {% endif %}
152 | 
153 |   <hr/>
154 | 
155 |   <h2>Link to the source</h2>
156 |   <!--
157 |     Support repo URL
158 |   -->
159 |   {% if repo_url %}
160 |     {% if repo_name == 'GitHub' %}
161 |       <a href="{{ repo_url }}"> Edit on GitHub</a>
162 |     {% elif repo_name == 'Bitbucket' %}
163 |       <a href="{{ repo_url }}"> Edit on BitBucket</a>
164 |     {% else %}
165 |       <a href="{{ repo_url }}"> Edit in Repository</a>
166 |     {% endif %}
167 |   {% endif %}
168 | 
169 |   <hr/>
170 | 
171 |   <h2>Show the table of contents for the current page</h2>
172 |   <ul>
173 |   {% for toc_item in toc %}
174 |       <li><a href="{{ toc_item.url }}">{{ toc_item.title }}</a></li>
175 |       {% for toc_item in toc_item.children %}
176 |           <li><a href="{{ toc_item.url }}">{{ toc_item.title }}</a></li>
177 |       {% endfor %}
178 |   {% endfor %}
179 |   </ul>
180 | 
181 |   <hr/>
182 | 
183 |   {% block content %}
184 |     {{ content }}
185 |   {% endblock %}
186 | 
187 |   <hr/>
188 | 
189 |   Built with <a href="http://www.mkdocs.org">MkDocs</a>.
190 | 
191 |   <!--
192 |   MkDocs version      : {{ mkdocs_version }}
193 |   Docs Build Date UTC : {{ build_date_utc }}
194 |   -->
195 | 
196 | </body>
197 | </html>
198 | {% endraw %}
199 | 


--------------------------------------------------------------------------------
/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/css/theme.css:
--------------------------------------------------------------------------------
1 | body {
2 |     margin: 1em;
3 | }
4 | 
5 | .active a {
6 |     color: red;
7 |     font-weight: bold;
8 | }
9 | 


--------------------------------------------------------------------------------
/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/js/theme.js:
--------------------------------------------------------------------------------
1 | /*
2 |  * This JavaScript doesn't do anything. The file exists just to demonstrate
3 |  * including static assets from the HTML in themes.
4 |  */
5 | 


--------------------------------------------------------------------------------
/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/nav.html:
--------------------------------------------------------------------------------
 1 | {% raw %}<!--
 2 | 
 3 | -->
 4 | {% if not nav_item.children %}
 5 | <li {% if nav_item.active %}class="active"{% endif %}>
 6 |     <a href="{{ nav_item.url }}">{{ nav_item.title }}</a>
 7 | </li>
 8 | {% else %}
 9 |   <li>
10 |     {{ nav_item.title }}
11 |     <ul>
12 |         {% for nav_item in nav_item.children %}
13 |             {% include "nav.html" %}
14 |         {% endfor %}
15 |     </ul>
16 |   </li>
17 | {% endif %}
18 | {% endraw %}
19 | 


--------------------------------------------------------------------------------
/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/search.html:
--------------------------------------------------------------------------------
 1 | {% raw %}
 2 | {% extends "base.html" %}
 3 | 
 4 | {% block extrahead %}
 5 |   <script>var base_url = '{{ base_url }}';</script>
 6 |   <script data-main="{{ base_url }}/mkdocs/js/search.js" src="{{ base_url }}/mkdocs/js/require.js"></script>
 7 | {% endblock %}
 8 | 
 9 | {% block content %}
10 | 
11 |   <h1 id="search">Search Results</h1>
12 | 
13 |   <form id="content_search" action="search.html">
14 |     <span role="status" aria-live="polite" class="ui-helper-hidden-accessible"></span>
15 |     <input name="q" id="mkdocs-search-query" type="text" class="search_input search-query ui-autocomplete-input" placeholder="Search the Docs" autocomplete="off">
16 |   </form>
17 | 
18 |   <div id="mkdocs-search-results">
19 |     Sorry, page not found.
20 |   </div>
21 | 
22 | {% endblock %}
23 | {% endraw %}
24 | 


--------------------------------------------------------------------------------