Skip to content

Commit 4f69710

Browse files
theacodestheacodes
committed
Update user guide with new theme
1 parent 2579a55 commit 4f69710

File tree

9 files changed

+368
-32
lines changed

9 files changed

+368
-32
lines changed

‎user_guide/docs/css/overrides.css‎

Lines changed: 0 additions & 25 deletions
This file was deleted.

‎user_guide/docs/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Winterbloom Big Honking Button User Guide
1+
# Big Honking Button User Guide
22

33
Big Honking Button is, well, a big button that honks. Okay, that's not all- it’s actually a simple sampler in a very silly package. It has pitch CV, gate in, gate out, and you can store up to 4mb of samples on it.
44

@@ -109,7 +109,7 @@ Big Honking Button can do all sorts of things! We've made a few examples to get
109109
1. [Noise example](https://github.com/theacodes/Winterbloom-Big-Honking-Button/blob/master/examples/noise.py): An advanced example that shows how to generate noise.
110110

111111

112-
## Help! I change some code and this thing isn't working!
112+
## Help! I changed some code and this thing isn't working!
113113

114114
There's probably some sort of error in the program. Don't worry, you can get it figured out.
115115

‎user_guide/mkdocs.yml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@ copyright: "© 2020 Winterbloom, licensed under Creative Commons CC BY-SA 4.0"
33
repo_url: "https://github.com/theacodes/Winterbloom-Big-Honking-Button"
44
edit_uri: edit/master/user_guide/docs
55
theme:
6-
name: cinder
7-
hljs_languages:
8-
- python
9-
extra_css:
10-
- "css/overrides.css"
6+
name: null
7+
custom_dir: 'theme/'
118
markdown_extensions:
129
- admonition
1310
- def_list
1411
- attr_list
1512
- toc:
1613
permalink: "#"
1714
toc_depth: 2
15+
- pymdownx.highlight:
16+
use_pygments: True
17+
- pymdownx.superfences
1818
nav:
1919
- "User Guide": index.md
2020
- "Kit Build Instructions": build.md

‎user_guide/theme/bootstrap.min.css‎

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎user_guide/theme/main.html‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5+
6+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
7+
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
8+
{% if config.site_description %}<meta name="description" content="{{ config.site_description }}">{% endif %}
9+
{% if config.site_author %}<meta name="author" content="{{ config.site_author }}">{% endif %}
10+
<link rel="shortcut icon" href="/favicon.ico">
11+
12+
<title>{% if page.title %}{{ page.title }} - {% endif %}{{ config.site_name }}</title>
13+
14+
<!-- Bootstrap core CSS -->
15+
<link href="/bootstrap.min.css" rel="stylesheet">
16+
17+
<!-- Custom styles for this template -->
18+
<link href="/style.css" rel="stylesheet">
19+
20+
<!-- Syntax highlighting css -->
21+
<link href="/pygments.css" rel="stylesheet">
22+
23+
{%- for path in config['extra_css'] %}
24+
<link href="{{ path|url }}" rel="stylesheet">
25+
{%- endfor %}
26+
27+
</head>
28+
<body>
29+
<div class="container">
30+
<nav class="navbar navbar-expand-lg navbar-light">
31+
<a class="navbar-brand" href="/">
32+
<img src="/winterbloom-logo.png" height="30" class="d-inline-block align-top" alt="" loading="lazy">
33+
</a>
34+
{% if nav|length>1 %}
35+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNavAltMarkup" aria-controls="navbarNavAltMarkup" aria-expanded="false" aria-label="Toggle navigation">
36+
<span class="navbar-toggler-icon"></span>
37+
</button>
38+
<div class="collapse navbar-collapse justify-content-end" id="navbarNavAltMarkup">
39+
<div class="navbar-nav">
40+
{% for nav_item in nav %}
41+
<a class="nav-link" href="{{ nav_item.url|url }}">{{ nav_item.title }}</a>
42+
{% endfor %}
43+
</div>
44+
</div>
45+
{% endif %}
46+
</nav>
47+
48+
<article>
49+
{{ page.content }}
50+
</article>
51+
52+
<footer>
53+
<p class="copyright">
54+
{{ config.copyright }}
55+
</p>
56+
<p class="edit-me">
57+
Found an issue? <a href="mailto:support@winterbloom.com">Send us a message</a> or <a href="{{page.edit_url}}">Edit this page on GitHub</a>.
58+
</p>
59+
<p class="updated">
60+
Last updated on {{build_date_utc.strftime('%B %d, %Y')}}
61+
</p>
62+
</footer>
63+
</div>
64+
</body>
65+
66+
<script type="text/javascript" src="/script.js"></script>
67+
</html>

‎user_guide/theme/pygments.css‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
pre { line-height: 125%; margin: 0; }
2+
td.linenos pre { color: #000000; background-color: #f0f0f0; padding: 0 5px 0 5px; }
3+
span.linenos { color: #000000; background-color: #f0f0f0; padding: 0 5px 0 5px; }
4+
td.linenos pre.special { color: #000000; background-color: #ffffc0; padding: 0 5px 0 5px; }
5+
span.linenos.special { color: #000000; background-color: #ffffc0; padding: 0 5px 0 5px; }
6+
pre .hll { background-color: #716799 }
7+
pre { background: #433e56; color: #F8F8F2 }
8+
pre .c { color: #b0bec5 } /* Comment */
9+
pre .err { color: #960050; background-color: #1e0010 } /* Error */
10+
pre .k { color: #C2FFDF } /* Keyword */
11+
pre .l { color: #ae81ff } /* Literal */
12+
pre .n { color: #F8F8F2 } /* Name */
13+
pre .o { color: #FFB8D1 } /* Operator */
14+
pre .p { color: #F8F8F2 } /* Punctuation */
15+
pre .ch { color: #b0bec5 } /* Comment.Hashbang */
16+
pre .cm { color: #b0bec5 } /* Comment.Multiline */
17+
pre .cp { color: #b0bec5 } /* Comment.Preproc */
18+
pre .cpf { color: #b0bec5 } /* Comment.PreprocFile */
19+
pre .c1 { color: #b0bec5 } /* Comment.Single */
20+
pre .cs { color: #b0bec5 } /* Comment.Special */
21+
pre .gd { color: #f92672 } /* Generic.Deleted */
22+
pre .ge { font-style: italic } /* Generic.Emph */
23+
pre .gi { color: #a6e22e } /* Generic.Inserted */
24+
pre .gs { font-weight: bold } /* Generic.Strong */
25+
pre .gu { color: #75715e } /* Generic.Subheading */
26+
pre .kc { color: #C2FFDF } /* Keyword.Constant */
27+
pre .kd { color: #C2FFDF } /* Keyword.Declaration */
28+
pre .kn { color: #FFB8D1 } /* Keyword.Namespace */
29+
pre .kp { color: #C2FFDF } /* Keyword.Pseudo */
30+
pre .kr { color: #C2FFDF } /* Keyword.Reserved */
31+
pre .kt { color: #C2FFDF } /* Keyword.Type */
32+
pre .ld { color: #e6db74 } /* Literal.Date */
33+
pre .m { color: #C5A3FF } /* Literal.Number */
34+
pre .s { color: #1bc5e0 } /* Literal.String */
35+
pre .na { color: #ceb1ff } /* Name.Attribute */
36+
pre .nb { color: #F8F8F2 } /* Name.Builtin */
37+
pre .nc { color: #ceb1ff } /* Name.Class */
38+
pre .no { color: #C5A3FF } /* Name.Constant */
39+
pre .nd { color: #ceb1ff } /* Name.Decorator */
40+
pre .ni { color: #F8F8F2 } /* Name.Entity */
41+
pre .ne { color: #ceb1ff } /* Name.Exception */
42+
pre .nf { color: #ceb1ff } /* Name.Function */
43+
pre .nl { color: #F8F8F2 } /* Name.Label */
44+
pre .nn { color: #F8F8F2 } /* Name.Namespace */
45+
pre .nx { color: #F8F8F2 } /* Name.Other */
46+
pre .py { color: #F8F8F2 } /* Name.Property */
47+
pre .nt { color: #FFB8D1 } /* Name.Tag */
48+
pre .nv { color: #F8F8F2 } /* Name.Variable */
49+
pre .ow { color: #FFB8D1 } /* Operator.Word */
50+
pre .w { color: #A8757B } /* Text.Whitespace */
51+
pre .mb { color: #C5A3FF } /* Literal.Number.Bin */
52+
pre .mf { color: #C5A3FF } /* Literal.Number.Float */
53+
pre .mh { color: #C5A3FF } /* Literal.Number.Hex */
54+
pre .mi { color: #C5A3FF } /* Literal.Number.Integer */
55+
pre .mo { color: #C5A3FF } /* Literal.Number.Oct */
56+
pre .sa { color: #1bc5e0 } /* Literal.String.Affix */
57+
pre .sb { color: #1bc5e0 } /* Literal.String.Backtick */
58+
pre .sc { color: #1bc5e0 } /* Literal.String.Char */
59+
pre .dl { color: #1bc5e0 } /* Literal.String.Delimiter */
60+
pre .sd { color: #1bc5e0 } /* Literal.String.Doc */
61+
pre .s2 { color: #1bc5e0 } /* Literal.String.Double */
62+
pre .se { color: #1bc5e0 } /* Literal.String.Escape */
63+
pre .sh { color: #1bc5e0 } /* Literal.String.Heredoc */
64+
pre .si { color: #1bc5e0 } /* Literal.String.Interpol */
65+
pre .sx { color: #1bc5e0 } /* Literal.String.Other */
66+
pre .sr { color: #1bc5e0 } /* Literal.String.Regex */
67+
pre .s1 { color: #1bc5e0 } /* Literal.String.Single */
68+
pre .ss { color: #1bc5e0 } /* Literal.String.Symbol */
69+
pre .bp { color: #80cbc4 } /* Name.Builtin.Pseudo */
70+
pre .fm { color: #ceb1ff } /* Name.Function.Magic */
71+
pre .vc { color: #F8F8F2 } /* Name.Variable.Class */
72+
pre .vg { color: #F8F8F2 } /* Name.Variable.Global */
73+
pre .vi { color: #F8F8F2 } /* Name.Variable.Instance */
74+
pre .vm { color: #F8F8F2 } /* Name.Variable.Magic */
75+
pre .il { color: #C5A3FF } /* Literal.Number.Integer.Long */

‎user_guide/theme/script.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
(function(){
2+
"use strict";
3+
4+
let nav_expand_button = document.querySelector("button.navbar-toggler");
5+
6+
if(nav_expand_button === null) {
7+
return;
8+
}
9+
10+
let nav_target = document.querySelector(nav_expand_button.dataset.target);
11+
console.log(nav_expand_button);
12+
console.log(nav_target);
13+
console.log(nav_expand_button.dataset.target);
14+
15+
nav_expand_button.addEventListener("click", function() {
16+
nav_target.classList.toggle("show");
17+
});
18+
})();

0 commit comments

Comments
 (0)