mirror of
https://github.com/MirrorNetworking/Mirror.git
synced 2024-11-18 02:50:32 +00:00
Added documentation folder
This commit is contained in:
Paul Pacheco
parent
0a4a43ceaf
commit
7e1806dce2
@ -34,6 +34,7 @@ skip_commits:
|
|||||||
- '**/*.md'
|
- '**/*.md'
|
||||||
- '**/*.txt'
|
- '**/*.txt'
|
||||||
- '.gitignore'
|
- '.gitignore'
|
||||||
|
- 'docs/*'
|
||||||
|
|
||||||
deploy:
|
deploy:
|
||||||
description: 'This is a bleeding edge release. BACKUP BEFORE USING THIS AUTOMATED BUILD\n$(APPVEYOR_REPO_COMMIT_MESSAGE)'
|
description: 'This is a bleeding edge release. BACKUP BEFORE USING THIS AUTOMATED BUILD\n$(APPVEYOR_REPO_COMMIT_MESSAGE)'
|
||||||
|
|||||||
11
docs/404.html
Normal file
11
docs/404.html
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
---
|
||||||
|
layout: page
|
||||||
|
color: red
|
||||||
|
title: Error 404
|
||||||
|
---
|
||||||
|
<div id="home" class="grid post">
|
||||||
|
<div class="unit whole">
|
||||||
|
<h1>Sorry. Looks like the page you requested does not exist.</h1>
|
||||||
|
<p style="text-align:center"><a href="{{ / | relative_url }}">Go back</a></p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
21
docs/LICENSE
Normal file
21
docs/LICENSE
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2014 Bitwiser.in
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in
|
||||||
|
all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
|
THE SOFTWARE.
|
||||||
27
docs/_config.yml
Normal file
27
docs/_config.yml
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
# Site settings
|
||||||
|
## Change the values as needed.
|
||||||
|
title: Mirror Documentation
|
||||||
|
email: paulpach@gmail.com
|
||||||
|
description: "A high level networking library for Unity"
|
||||||
|
keywords: "Mirror, HLAPI, UNET, Network"
|
||||||
|
|
||||||
|
paginate_path: "page:num"
|
||||||
|
# Build settings
|
||||||
|
markdown: kramdown
|
||||||
|
highlighter: pygments
|
||||||
|
sass:
|
||||||
|
sass_dir: _sass
|
||||||
|
style: :compressed
|
||||||
|
links:
|
||||||
|
discord:
|
||||||
|
github: paulpach/Mirror
|
||||||
|
exclude:
|
||||||
|
- bower_components
|
||||||
|
- README.md
|
||||||
|
|
||||||
|
##set this to enable disqus commenting
|
||||||
|
disqus: bitwiser
|
||||||
|
|
||||||
|
##set this to enable google analytics
|
||||||
|
#ga_id: analyticsID
|
||||||
|
#ga_domain: bitwiser.in
|
||||||
18
docs/_data/navigation.yml
Normal file
18
docs/_data/navigation.yml
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
- title: "Classes"
|
||||||
|
children:
|
||||||
|
- title: "Class A"
|
||||||
|
url: "/docs/A"
|
||||||
|
- title: "Class B"
|
||||||
|
url: "/docs/B"
|
||||||
|
- title: "Guides"
|
||||||
|
children:
|
||||||
|
- title: "Child Page B1"
|
||||||
|
url: /
|
||||||
|
- title: "Child Page B2"
|
||||||
|
url: /
|
||||||
|
- title: "Child Page B3"
|
||||||
|
url: /
|
||||||
|
- title: "Child Page B4"
|
||||||
|
url: /
|
||||||
|
- title: "Child Page B5"
|
||||||
|
url: /
|
||||||
10
docs/_includes/analytics.html
Normal file
10
docs/_includes/analytics.html
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
<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', '{{ site.ga_id }}', '{{ site.ga_domain }}');
|
||||||
|
ga('require', 'displayfeatures');
|
||||||
|
ga('send', 'pageview');
|
||||||
|
</script>
|
||||||
21
docs/_includes/disqus.html
Normal file
21
docs/_includes/disqus.html
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
<div id="disqus_thread"></div>
|
||||||
|
<script>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* RECOMMENDED CONFIGURATION VARIABLES: EDIT AND UNCOMMENT THE SECTION BELOW TO INSERT DYNAMIC VALUES FROM YOUR PLATFORM OR CMS.
|
||||||
|
* LEARN WHY DEFINING THESE VARIABLES IS IMPORTANT: https://disqus.com/admin/universalcode/#configuration-variables*/
|
||||||
|
|
||||||
|
var disqus_config = function () {
|
||||||
|
this.page.url = "{{site.url}}{{page.url}}"; // Replace PAGE_URL with your page's canonical URL variable
|
||||||
|
this.page.identifier = "{{page.url}}"; // Replace PAGE_IDENTIFIER with your page's unique identifier variable
|
||||||
|
};
|
||||||
|
|
||||||
|
(function() { // DON'T EDIT BELOW THIS LINE
|
||||||
|
var d = document, s = d.createElement('script');
|
||||||
|
s.src = 'https://mirror-1.disqus.com/embed.js';
|
||||||
|
s.setAttribute('data-timestamp', +new Date());
|
||||||
|
(d.head || d.body).appendChild(s);
|
||||||
|
})();
|
||||||
|
</script>
|
||||||
|
<noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
|
||||||
|
|
||||||
5
docs/_includes/footer.html
Normal file
5
docs/_includes/footer.html
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
<footer class="site-footer">
|
||||||
|
<div class="footer-col-wrapper">
|
||||||
|
<a href="https://github.com/{{ site.links.github }}" target="_blank" class="mui-btn"><i class="fa fa-github"></i>Github</a>
|
||||||
|
</div>
|
||||||
|
</footer>
|
||||||
45
docs/_includes/head.html
Normal file
45
docs/_includes/head.html
Normal file
@ -0,0 +1,45 @@
|
|||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
|
||||||
|
<title>{% if page.title %}{{ page.title }} - {{ site.title }}{% else %}{{ site.title }}{% endif %}</title>
|
||||||
|
<meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description | strip_newlines }}{% endif %}">
|
||||||
|
|
||||||
|
<link href="//fonts.googleapis.com/css?family=Roboto:300,400,400italic,500,700" rel="stylesheet" type="text/css" />
|
||||||
|
<link href="//cdnjs.cloudflare.com/ajax/libs/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet" type="text/css" />
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="{{ "/css/main.css" | relative_url }}">
|
||||||
|
<link rel="canonical" href="{{ page.url | replace:'index.html',''}}">
|
||||||
|
<script src="{{ "/js/mui.min.js" | relative_url }}"></script>
|
||||||
|
<style>
|
||||||
|
body {
|
||||||
|
font-family: "Roboto", "Helvetica Neue", Helvetica, Arial;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
|
||||||
|
<meta property="og:title" content="{% if page.title %}{{ page.title }} - {{ site.title }}{% else %}{{ site.title }}{% endif %}" />
|
||||||
|
<meta name="twitter:title" content="{% if page.title %}{{ page.title }} - {{ site.title }}{% else %}{{ site.title }}{% endif %}" />
|
||||||
|
{% if page.tags and page.tags.size > 0 %}
|
||||||
|
<meta name="keywords" content="{% for tag in page.tags %}{{ tag }}, {% endfor %}" />
|
||||||
|
{% elsif site.keywords %}
|
||||||
|
<meta name="keywords" content="{{ site.keywords }}" />
|
||||||
|
{% endif %}
|
||||||
|
<meta property="og:description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description | strip_newlines }}{% endif %}" />
|
||||||
|
<meta name="twitter:description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description | strip_newlines }}{% endif %}" />
|
||||||
|
{% if page.title %}
|
||||||
|
<meta property="og:type" content="article" />
|
||||||
|
{% else %}
|
||||||
|
<meta property="og:type" content="website" />
|
||||||
|
<meta property="og:url" content="{{ page.url | replace:'index.html','' }}" />
|
||||||
|
{% endif %}
|
||||||
|
<meta property="og:site_name" content="{{ site.title }}" />
|
||||||
|
{% if page.cover %}
|
||||||
|
<meta property="og:image" content="{{ site.base_url }}/{{page.cover}}" />
|
||||||
|
<meta property="twitter:image" content="{{ site.base_url }}/{{page.cover}}" />
|
||||||
|
{% else %}
|
||||||
|
<meta name="og:image" content="{{ site.base_url }}/img/sharer.png" />
|
||||||
|
<meta name="twitter:image" content="{{ site.base_url }}/img/sharer.png" />
|
||||||
|
{% endif %}
|
||||||
|
<meta name="twitter:card" content="summary" />
|
||||||
|
</head>
|
||||||
12
docs/_includes/header.html
Normal file
12
docs/_includes/header.html
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
<header class="mui-appbar-height site-appbar mui-z2">
|
||||||
|
|
||||||
|
<div class="mui-container">
|
||||||
|
<div style="float: left">
|
||||||
|
|
||||||
|
<a class="site-title" href="{{ site.baseurl }}/">
|
||||||
|
<h1>{{ site.title }}</h1>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</header>
|
||||||
13
docs/_includes/sidebar.html
Normal file
13
docs/_includes/sidebar.html
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<div class="mui-col-md-4">
|
||||||
|
<div class="mui-panel">
|
||||||
|
|
||||||
|
{% for category in site.data.navigation %}
|
||||||
|
<h2>{{category.title}}</h2>
|
||||||
|
<ul class="about-links">
|
||||||
|
{% for document in category.children %}
|
||||||
|
<li><a href="{{document.url | relative_url}}" class="mui-btn"><i class="fa"></i>{{document.title }}</a></li>
|
||||||
|
{%endfor%}
|
||||||
|
</ul>
|
||||||
|
{% endfor %}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
16
docs/_layouts/base.html
Normal file
16
docs/_layouts/base.html
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
|
||||||
|
{% include head.html %}
|
||||||
|
|
||||||
|
<body>
|
||||||
|
|
||||||
|
{{ content }}
|
||||||
|
|
||||||
|
{% if site.ga_id %}
|
||||||
|
{% include analytics.html %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
<script id="dsq-count-scr" src="//mirror-1.disqus.com/count.js" async></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
20
docs/_layouts/default.html
Normal file
20
docs/_layouts/default.html
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
layout: base
|
||||||
|
---
|
||||||
|
|
||||||
|
{% include header.html %}
|
||||||
|
|
||||||
|
<div class="mui-container">
|
||||||
|
<div class="home mui-row">
|
||||||
|
<div class="mui-col-md-8">
|
||||||
|
{{ content }}
|
||||||
|
</div>
|
||||||
|
{% include sidebar.html %}
|
||||||
|
</div>
|
||||||
|
<div class="home mui-row">
|
||||||
|
{% include disqus.html %}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
{% include footer.html %}
|
||||||
27
docs/_posts/2015-07-11-welcome-to-jekyll.markdown
Normal file
27
docs/_posts/2015-07-11-welcome-to-jekyll.markdown
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
---
|
||||||
|
layout: post
|
||||||
|
color: deep-purple
|
||||||
|
cover: "http://s3-ap-southeast-1.amazonaws.com/monster-machine/images/horssghonr-1436272011-Midas.jpg"
|
||||||
|
title: "Welcome to Jekyll!"
|
||||||
|
date: 2015-07-11 13:50:39
|
||||||
|
categories: jekyll update
|
||||||
|
---
|
||||||
|
You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.
|
||||||
|
|
||||||
|
To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.
|
||||||
|
|
||||||
|
Jekyll also offers powerful support for code snippets:
|
||||||
|
|
||||||
|
{% highlight ruby %}
|
||||||
|
def print_hi(name)
|
||||||
|
puts "Hi, #{name}"
|
||||||
|
end
|
||||||
|
print_hi('Tom')
|
||||||
|
#=> prints 'Hi, Tom' to STDOUT.
|
||||||
|
{% endhighlight %}
|
||||||
|
|
||||||
|
Check out the [Jekyll docs][jekyll] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll’s dedicated Help repository][jekyll-help].
|
||||||
|
|
||||||
|
[jekyll]: http://jekyllrb.com
|
||||||
|
[jekyll-gh]: https://github.com/jekyll/jekyll
|
||||||
|
[jekyll-help]: https://github.com/jekyll/jekyll-help
|
||||||
53
docs/_posts/2015-07-12-color-choices.md
Normal file
53
docs/_posts/2015-07-12-color-choices.md
Normal file
@ -0,0 +1,53 @@
|
|||||||
|
---
|
||||||
|
layout: post
|
||||||
|
color: purple
|
||||||
|
title: "Color Choices"
|
||||||
|
date: 2015-07-12 01:54:00
|
||||||
|
---
|
||||||
|
|
||||||
|
### Any of the following color values can be used as the value of `color` in the front matter of the blog post.
|
||||||
|
<div class="bg-grey">
|
||||||
|
<h2><a href="#">grey</a></h2>
|
||||||
|
</div>
|
||||||
|
<div class="bg-orange">
|
||||||
|
<h2><a href="#">orange</a></h2>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="bg-yellow">
|
||||||
|
<h2><a href="#">yellow</a></h2>
|
||||||
|
</div>
|
||||||
|
<div class="bg-amber">
|
||||||
|
<h2><a href="#">amber</a></h2>
|
||||||
|
</div>
|
||||||
|
<div class="bg-light-blue">
|
||||||
|
<h2><a href="#">light-blue</a></h2>
|
||||||
|
</div>
|
||||||
|
<div class="bg-lime">
|
||||||
|
<h2><a href="#">lime</a></h2>
|
||||||
|
</div>
|
||||||
|
<div class="bg-teal">
|
||||||
|
<h2><a href="#">teal</a></h2>
|
||||||
|
</div>
|
||||||
|
<div class="bg-black-87">
|
||||||
|
<h2><a href="#">black-87</a></h2>
|
||||||
|
</div>
|
||||||
|
<div class="bg-blue-grey">
|
||||||
|
<h2><a href="#">blue-grey</a></h2>
|
||||||
|
</div>
|
||||||
|
<div class="bg-brown">
|
||||||
|
<h2><a href="#">brown</a></h2>
|
||||||
|
</div>
|
||||||
|
<div class="bg-indigo">
|
||||||
|
<h2><a href="#">indigo</a></h2>
|
||||||
|
</div>
|
||||||
|
<div class="bg-purple">
|
||||||
|
<h2><a href="#">purple</a></h2>
|
||||||
|
</div>
|
||||||
|
<div class="bg-deep-purple">
|
||||||
|
<h2><a href="#">deep-purple</a></h2>
|
||||||
|
</div>
|
||||||
|
<div class="bg-red">
|
||||||
|
<h2><a href="#">red</a></h2>
|
||||||
|
</div><div class="bg-pink">
|
||||||
|
<h2><a href="#">pink</a></h2>
|
||||||
|
</div>
|
||||||
124
docs/_posts/2015-07-12-demo-post.md
Normal file
124
docs/_posts/2015-07-12-demo-post.md
Normal file
@ -0,0 +1,124 @@
|
|||||||
|
---
|
||||||
|
layout: post
|
||||||
|
color: deep-purple
|
||||||
|
title: "Demo Post"
|
||||||
|
date: 2015-07-12 01:55:00
|
||||||
|
---
|
||||||
|
|
||||||
|
<p><small>This demo page has been used from <a href="http://jasonm23.github.io/markdown-css-themes/" target="_blank">http://jasonm23.github.io/markdown-css-themes/</a>.</small></p>
|
||||||
|
|
||||||
|
<h1>A First Level Header</h1>
|
||||||
|
|
||||||
|
<h2>A Second Level Header</h2>
|
||||||
|
|
||||||
|
<h3>A Third Level Header</h3>
|
||||||
|
|
||||||
|
<h4>A Fourth Level Header</h4>
|
||||||
|
|
||||||
|
<h5>A Fifth Level Header</h5>
|
||||||
|
|
||||||
|
<h6>A Sixed Level Header</h6>
|
||||||
|
|
||||||
|
<p>Now is the time for all good men to come to
|
||||||
|
the aid of their country. This is just a
|
||||||
|
regular paragraph.</p>
|
||||||
|
|
||||||
|
<p>The quick brown fox jumped over the lazy
|
||||||
|
dog’s back.</p>
|
||||||
|
|
||||||
|
<hr />
|
||||||
|
|
||||||
|
<h3>Header 3</h3>
|
||||||
|
|
||||||
|
<blockquote><p>This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
|
||||||
|
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
|
||||||
|
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.</p>
|
||||||
|
|
||||||
|
<p>Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
|
||||||
|
id sem consectetuer libero luctus adipiscing.</p>
|
||||||
|
|
||||||
|
<h2>This is an H2 in a blockquote</h2>
|
||||||
|
|
||||||
|
<p>This is the first level of quoting.</p>
|
||||||
|
|
||||||
|
<blockquote><p>This is nested blockquote.</p></blockquote>
|
||||||
|
|
||||||
|
<p>Back to the first level.</p></blockquote>
|
||||||
|
|
||||||
|
<p>Some of these words <em>are emphasized</em>.
|
||||||
|
Some of these words <em>are emphasized also</em>.</p>
|
||||||
|
|
||||||
|
<p>Use two asterisks for <strong>strong emphasis</strong>.
|
||||||
|
Or, if you prefer, <strong>use two underscores instead</strong>.</p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>Candy.</li>
|
||||||
|
<li>Gum.</li>
|
||||||
|
<li>Booze.</li>
|
||||||
|
<li>Red</li>
|
||||||
|
<li>Green</li>
|
||||||
|
<li><p>Blue</p></li>
|
||||||
|
<li><p>A list item.</p></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<p>With multiple paragraphs.</p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><p>Another item in the list.</p></li>
|
||||||
|
<li><p>This is a list item with two paragraphs. Lorem ipsum dolor
|
||||||
|
sit amet, consectetuer adipiscing elit. Aliquam hendrerit
|
||||||
|
mi posuere lectus.</p></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<p>Vestibulum enim wisi, viverra nec, fringilla in, laoreet
|
||||||
|
vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
|
||||||
|
sit amet velit.* Suspendisse id sem consectetuer libero luctus adipiscing.</p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>This is a list item with two paragraphs.</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<p>This is the second paragraph in the list item. You’re
|
||||||
|
only required to indent the first line. Lorem ipsum dolor
|
||||||
|
sit amet, consectetuer adipiscing elit.</p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><p>Another item in the same list.</p></li>
|
||||||
|
<li><p>A list item with a bit of <code>code</code> inline.</p></li>
|
||||||
|
<li><p>A list item with a blockquote:</p>
|
||||||
|
|
||||||
|
<blockquote><p>This is a blockquote
|
||||||
|
inside a list item.</p></blockquote></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<p>Here is an example of a pre code block</p>
|
||||||
|
|
||||||
|
<pre><code>tell application "Foo"
|
||||||
|
beep
|
||||||
|
end tell
|
||||||
|
</code></pre>
|
||||||
|
|
||||||
|
<p>This is an <a href="#">example link</a>.</p>
|
||||||
|
|
||||||
|
<p>I start my morning with a cup of coffee and
|
||||||
|
<a href="http://www.nytimes.com/">The New York Times</a>.</p>
|
||||||
|
|
||||||
|
### Code snippet
|
||||||
|
|
||||||
|
{% highlight python %}
|
||||||
|
if __name__ =='__main__':
|
||||||
|
img_thread = threading.Thread(target=downloadWallpaper)
|
||||||
|
img_thread.start()
|
||||||
|
st = '\rDownloading Image'
|
||||||
|
current = 1
|
||||||
|
while img_thread.is_alive():
|
||||||
|
sys.stdout.write(st+'.'*((current)%5))
|
||||||
|
current=current+1
|
||||||
|
time.sleep(0.3)
|
||||||
|
img_thread.join()
|
||||||
|
print('\nImage of the day downloaded.')
|
||||||
|
{% endhighlight %}
|
||||||
348
docs/_sass/_colors.scss
Normal file
348
docs/_sass/_colors.scss
Normal file
@ -0,0 +1,348 @@
|
|||||||
|
/**
|
||||||
|
* MUI Colors module
|
||||||
|
*/
|
||||||
|
|
||||||
|
// ============================================================================
|
||||||
|
// COLOR FUNCTION
|
||||||
|
// ============================================================================
|
||||||
|
@function mui-color($mui-key1, $mui-key2: '500') {
|
||||||
|
// check key1
|
||||||
|
@if map-has-key($mui-colors, $mui-key1) == false {
|
||||||
|
@warn "Color `#{$mui-key1}` not found.";
|
||||||
|
@return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
$mui-mapVal: map-get($mui-colors, $mui-key1);
|
||||||
|
|
||||||
|
// use second key
|
||||||
|
@if type-of($mui-mapVal) == 'map' {
|
||||||
|
// check key2
|
||||||
|
@if map-has-key($mui-mapVal, $mui-key2) == false {
|
||||||
|
@warn "Color `#{$mui-key1}` `#{$mui-key2}` not found.";
|
||||||
|
@return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
$mui-mapVal: map-get($mui-mapVal, $mui-key2);
|
||||||
|
}
|
||||||
|
|
||||||
|
@return $mui-mapVal;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// ============================================================================
|
||||||
|
// COLOR MAP
|
||||||
|
// ============================================================================
|
||||||
|
$mui-colors: (
|
||||||
|
"red": (
|
||||||
|
"50": #FFEBEE,
|
||||||
|
"100": #FFCDD2,
|
||||||
|
"200": #EF9A9A,
|
||||||
|
"300": #E57373,
|
||||||
|
"400": #EF5350,
|
||||||
|
"500": #F44336,
|
||||||
|
"600": #E53935,
|
||||||
|
"700": #D32F2F,
|
||||||
|
"800": #C62828,
|
||||||
|
"900": #B71C1C,
|
||||||
|
"A100": #FF8A80,
|
||||||
|
"A200": #FF5252,
|
||||||
|
"A400": #FF1744,
|
||||||
|
"A700": #D50000,
|
||||||
|
),
|
||||||
|
"pink": (
|
||||||
|
"50": #FCE4EC,
|
||||||
|
"100": #F8BBD0,
|
||||||
|
"200": #F48FB1,
|
||||||
|
"300": #F06292,
|
||||||
|
"400": #EC407A,
|
||||||
|
"500": #E91E63,
|
||||||
|
"600": #D81B60,
|
||||||
|
"700": #C2185B,
|
||||||
|
"800": #AD1457,
|
||||||
|
"900": #880E4F,
|
||||||
|
"A100": #FF80AB,
|
||||||
|
"A200": #FF4081,
|
||||||
|
"A400": #F50057,
|
||||||
|
"A700": #C51162,
|
||||||
|
),
|
||||||
|
"purple": (
|
||||||
|
"50": #F3E5F5,
|
||||||
|
"100": #E1BEE7,
|
||||||
|
"200": #CE93D8,
|
||||||
|
"300": #BA68C8,
|
||||||
|
"400": #AB47BC,
|
||||||
|
"500": #9C27B0,
|
||||||
|
"600": #8E24AA,
|
||||||
|
"700": #7B1FA2,
|
||||||
|
"800": #6A1B9A,
|
||||||
|
"900": #4A148C,
|
||||||
|
"A100": #EA80FC,
|
||||||
|
"A200": #E040FB,
|
||||||
|
"A400": #D500F9,
|
||||||
|
"A700": #AA00FF,
|
||||||
|
),
|
||||||
|
"deep-purple": (
|
||||||
|
"50": #EDE7F6,
|
||||||
|
"100": #D1C4E9,
|
||||||
|
"200": #B39DDB,
|
||||||
|
"300": #9575CD,
|
||||||
|
"400": #7E57C2,
|
||||||
|
"500": #673AB7,
|
||||||
|
"600": #5E35B1,
|
||||||
|
"700": #512DA8,
|
||||||
|
"800": #4527A0,
|
||||||
|
"900": #311B92,
|
||||||
|
"A100": #B388FF,
|
||||||
|
"A200": #7C4DFF,
|
||||||
|
"A400": #651FFF,
|
||||||
|
"A700": #6200EA,
|
||||||
|
),
|
||||||
|
"indigo": (
|
||||||
|
"50": #E8EAF6,
|
||||||
|
"100": #C5CAE9,
|
||||||
|
"200": #9FA8DA,
|
||||||
|
"300": #7986CB,
|
||||||
|
"400": #5C6BC0,
|
||||||
|
"500": #3F51B5,
|
||||||
|
"600": #3949AB,
|
||||||
|
"700": #303F9F,
|
||||||
|
"800": #283593,
|
||||||
|
"900": #1A237E,
|
||||||
|
"A100": #8C9EFF,
|
||||||
|
"A200": #536DFE,
|
||||||
|
"A400": #3D5AFE,
|
||||||
|
"A700": #304FFE,
|
||||||
|
),
|
||||||
|
"blue": (
|
||||||
|
"50": #E3F2FD,
|
||||||
|
"100": #BBDEFB,
|
||||||
|
"200": #90CAF9,
|
||||||
|
"300": #64B5F6,
|
||||||
|
"400": #42A5F5,
|
||||||
|
"500": #2196F3,
|
||||||
|
"600": #1E88E5,
|
||||||
|
"700": #1976D2,
|
||||||
|
"800": #1565C0,
|
||||||
|
"900": #0D47A1,
|
||||||
|
"A100": #82B1FF,
|
||||||
|
"A200": #448AFF,
|
||||||
|
"A400": #2979FF,
|
||||||
|
"A700": #2962FF,
|
||||||
|
),
|
||||||
|
"light-blue": (
|
||||||
|
"50": #E1F5FE,
|
||||||
|
"100": #B3E5FC,
|
||||||
|
"200": #81D4FA,
|
||||||
|
"300": #4FC3F7,
|
||||||
|
"400": #29B6F6,
|
||||||
|
"500": #03A9F4,
|
||||||
|
"600": #039BE5,
|
||||||
|
"700": #0288D1,
|
||||||
|
"800": #0277BD,
|
||||||
|
"900": #01579B,
|
||||||
|
"A100": #80D8FF,
|
||||||
|
"A200": #40C4FF,
|
||||||
|
"A400": #00B0FF,
|
||||||
|
"A700": #0091EA,
|
||||||
|
),
|
||||||
|
"cyan": (
|
||||||
|
"50": #E0F7FA,
|
||||||
|
"100": #B2EBF2,
|
||||||
|
"200": #80DEEA,
|
||||||
|
"300": #4DD0E1,
|
||||||
|
"400": #26C6DA,
|
||||||
|
"500": #00BCD4,
|
||||||
|
"600": #00ACC1,
|
||||||
|
"700": #0097A7,
|
||||||
|
"800": #00838F,
|
||||||
|
"900": #006064,
|
||||||
|
"A100": #84FFFF,
|
||||||
|
"A200": #18FFFF,
|
||||||
|
"A400": #00E5FF,
|
||||||
|
"A700": #00B8D4,
|
||||||
|
),
|
||||||
|
"teal": (
|
||||||
|
"50": #E0F2F1,
|
||||||
|
"100": #B2DFDB,
|
||||||
|
"200": #80CBC4,
|
||||||
|
"300": #4DB6AC,
|
||||||
|
"400": #26A69A,
|
||||||
|
"500": #009688,
|
||||||
|
"600": #00897B,
|
||||||
|
"700": #00796B,
|
||||||
|
"800": #00695C,
|
||||||
|
"900": #004D40,
|
||||||
|
"A100": #A7FFEB,
|
||||||
|
"A200": #64FFDA,
|
||||||
|
"A400": #1DE9B6,
|
||||||
|
"A700": #00BFA5,
|
||||||
|
),
|
||||||
|
"green": (
|
||||||
|
"50": #E8F5E9,
|
||||||
|
"100": #C8E6C9,
|
||||||
|
"200": #A5D6A7,
|
||||||
|
"300": #81C784,
|
||||||
|
"400": #66BB6A,
|
||||||
|
"500": #4CAF50,
|
||||||
|
"600": #43A047,
|
||||||
|
"700": #388E3C,
|
||||||
|
"800": #2E7D32,
|
||||||
|
"900": #1B5E20,
|
||||||
|
"A100": #B9F6CA,
|
||||||
|
"A200": #69F0AE,
|
||||||
|
"A400": #00E676,
|
||||||
|
"A700": #00C853,
|
||||||
|
),
|
||||||
|
"light-green": (
|
||||||
|
"50": #F1F8E9,
|
||||||
|
"100": #DCEDC8,
|
||||||
|
"200": #C5E1A5,
|
||||||
|
"300": #AED581,
|
||||||
|
"400": #9CCC65,
|
||||||
|
"500": #8BC34A,
|
||||||
|
"600": #7CB342,
|
||||||
|
"700": #689F38,
|
||||||
|
"800": #558B2F,
|
||||||
|
"900": #33691E,
|
||||||
|
"A100": #CCFF90,
|
||||||
|
"A200": #B2FF59,
|
||||||
|
"A400": #76FF03,
|
||||||
|
"A700": #64DD17,
|
||||||
|
),
|
||||||
|
"lime": (
|
||||||
|
"50": #F9FBE7,
|
||||||
|
"100": #F0F4C3,
|
||||||
|
"200": #E6EE9C,
|
||||||
|
"300": #DCE775,
|
||||||
|
"400": #D4E157,
|
||||||
|
"500": #CDDC39,
|
||||||
|
"600": #C0CA33,
|
||||||
|
"700": #AFB42B,
|
||||||
|
"800": #9E9D24,
|
||||||
|
"900": #827717,
|
||||||
|
"A100": #F4FF81,
|
||||||
|
"A200": #EEFF41,
|
||||||
|
"A400": #C6FF00,
|
||||||
|
"A700": #AEEA00,
|
||||||
|
),
|
||||||
|
"yellow": (
|
||||||
|
"50": #FFFDE7,
|
||||||
|
"100": #FFF9C4,
|
||||||
|
"200": #FFF59D,
|
||||||
|
"300": #FFF176,
|
||||||
|
"400": #FFEE58,
|
||||||
|
"500": #FFEB3B,
|
||||||
|
"600": #FDD835,
|
||||||
|
"700": #FBC02D,
|
||||||
|
"800": #F9A825,
|
||||||
|
"900": #F57F17,
|
||||||
|
"A100": #FFFF8D,
|
||||||
|
"A200": #FFFF00,
|
||||||
|
"A400": #FFEA00,
|
||||||
|
"A700": #FFD600,
|
||||||
|
),
|
||||||
|
"amber": (
|
||||||
|
"50": #FFF8E1,
|
||||||
|
"100": #FFECB3,
|
||||||
|
"200": #FFE082,
|
||||||
|
"300": #FFD54F,
|
||||||
|
"400": #FFCA28,
|
||||||
|
"500": #FFC107,
|
||||||
|
"600": #FFB300,
|
||||||
|
"700": #FFA000,
|
||||||
|
"800": #FF8F00,
|
||||||
|
"900": #FF6F00,
|
||||||
|
"A100": #FFE57F,
|
||||||
|
"A200": #FFD740,
|
||||||
|
"A400": #FFC400,
|
||||||
|
"A700": #FFAB00,
|
||||||
|
),
|
||||||
|
"orange": (
|
||||||
|
"50": #FFF3E0,
|
||||||
|
"100": #FFE0B2,
|
||||||
|
"200": #FFCC80,
|
||||||
|
"300": #FFB74D,
|
||||||
|
"400": #FFA726,
|
||||||
|
"500": #FF9800,
|
||||||
|
"600": #FB8C00,
|
||||||
|
"700": #F57C00,
|
||||||
|
"800": #EF6C00,
|
||||||
|
"900": #E65100,
|
||||||
|
"A100": #FFD180,
|
||||||
|
"A200": #FFAB40,
|
||||||
|
"A400": #FF9100,
|
||||||
|
"A700": #FF6D00,
|
||||||
|
),
|
||||||
|
"deep-orange": (
|
||||||
|
"50": #FBE9E7,
|
||||||
|
"100": #FFCCBC,
|
||||||
|
"200": #FFAB91,
|
||||||
|
"300": #FF8A65,
|
||||||
|
"400": #FF7043,
|
||||||
|
"500": #FF5722,
|
||||||
|
"600": #F4511E,
|
||||||
|
"700": #E64A19,
|
||||||
|
"800": #D84315,
|
||||||
|
"900": #BF360C,
|
||||||
|
"A100": #FF9E80,
|
||||||
|
"A200": #FF6E40,
|
||||||
|
"A400": #FF3D00,
|
||||||
|
"A700": #DD2C00,
|
||||||
|
),
|
||||||
|
"brown": (
|
||||||
|
"50": #EFEBE9,
|
||||||
|
"100": #D7CCC8,
|
||||||
|
"200": #BCAAA4,
|
||||||
|
"300": #A1887F,
|
||||||
|
"400": #8D6E63,
|
||||||
|
"500": #795548,
|
||||||
|
"600": #6D4C41,
|
||||||
|
"700": #5D4037,
|
||||||
|
"800": #4E342E,
|
||||||
|
"900": #3E2723,
|
||||||
|
),
|
||||||
|
"grey": (
|
||||||
|
"50": #FAFAFA,
|
||||||
|
"100": #F5F5F5,
|
||||||
|
"200": #EEEEEE,
|
||||||
|
"300": #E0E0E0,
|
||||||
|
"400": #BDBDBD,
|
||||||
|
"500": #9E9E9E,
|
||||||
|
"600": #757575,
|
||||||
|
"700": #616161,
|
||||||
|
"800": #424242,
|
||||||
|
"900": #212121,
|
||||||
|
),
|
||||||
|
"blue-grey": (
|
||||||
|
"50": #ECEFF1,
|
||||||
|
"100": #CFD8DC,
|
||||||
|
"200": #B0BEC5,
|
||||||
|
"300": #90A4AE,
|
||||||
|
"400": #78909C,
|
||||||
|
"500": #607D8B,
|
||||||
|
"600": #546E7A,
|
||||||
|
"700": #455A64,
|
||||||
|
"800": #37474F,
|
||||||
|
"900": #263238,
|
||||||
|
),
|
||||||
|
"black": #000,
|
||||||
|
"white": #FFF,
|
||||||
|
"black-alpha-1": rgba(0, 0, 0, 0.12),
|
||||||
|
"black-alpha-2": rgba(0, 0, 0, 0.26),
|
||||||
|
"black-alpha-3": rgba(0, 0, 0, 0.54),
|
||||||
|
"black-alpha-4": rgba(0, 0, 0, 0.87),
|
||||||
|
"white-alpha-1": rgba(255, 255, 255, 0.12),
|
||||||
|
"white-alpha-2": rgba(255, 255, 255, 0.30),
|
||||||
|
"white-alpha-3": rgba(255, 255, 255, 0.70),
|
||||||
|
"white-alpha-4": rgba(255, 255, 255, 1.00),
|
||||||
|
|
||||||
|
"black-alpha-12": rgba(#000, 0.12),
|
||||||
|
"black-alpha-26": rgba(#000, 0.26),
|
||||||
|
"black-alpha-54": rgba(#000, 0.54),
|
||||||
|
"black-alpha-87": rgba(#000, 0.87),
|
||||||
|
"white-alpha-12": rgba(#FFF, 0.12),
|
||||||
|
"white-alpha-30": rgba(#FFF, 0.30),
|
||||||
|
"white-alpha-70": rgba(#FFF, 0.70),
|
||||||
|
);
|
||||||
3093
docs/_sass/_mui.scss
Normal file
3093
docs/_sass/_mui.scss
Normal file
File diff suppressed because it is too large
Load Diff
78
docs/_sass/_syntax-highlighting.scss
Normal file
78
docs/_sass/_syntax-highlighting.scss
Normal file
@ -0,0 +1,78 @@
|
|||||||
|
/**
|
||||||
|
* Syntax highlighting styles
|
||||||
|
*/
|
||||||
|
.highlight {
|
||||||
|
|
||||||
|
padding: 2px;
|
||||||
|
|
||||||
|
pre {
|
||||||
|
border: 1px solid #186B9C;
|
||||||
|
}
|
||||||
|
|
||||||
|
.lineno {
|
||||||
|
background-color: #D7D7D7;
|
||||||
|
}
|
||||||
|
.hll { background-color: #ffffcc }
|
||||||
|
.c { color: #888888 } /* Comment */
|
||||||
|
.err { color: #FF0000; background-color: #FFAAAA } /* Error */
|
||||||
|
.k { color: #008800; font-weight: bold } /* Keyword */
|
||||||
|
.o { color: #333333 } /* Operator */
|
||||||
|
.cm { color: #888888 } /* Comment.Multiline */
|
||||||
|
.cp { color: #557799 } /* Comment.Preproc */
|
||||||
|
.c1 { color: #888888 } /* Comment.Single */
|
||||||
|
.cs { color: #cc0000; font-weight: bold } /* Comment.Special */
|
||||||
|
.gd { color: #A00000 } /* Generic.Deleted */
|
||||||
|
.ge { font-style: italic } /* Generic.Emph */
|
||||||
|
.gr { color: #FF0000 } /* Generic.Error */
|
||||||
|
.gh { color: #000080; font-weight: bold } /* Generic.Heading */
|
||||||
|
.gi { color: #00A000 } /* Generic.Inserted */
|
||||||
|
.go { color: #888888 } /* Generic.Output */
|
||||||
|
.gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
|
||||||
|
.gs { font-weight: bold } /* Generic.Strong */
|
||||||
|
.gu { color: #800080; font-weight: bold } /* Generic.Subheading */
|
||||||
|
.gt { color: #0044DD } /* Generic.Traceback */
|
||||||
|
.kc { color: #008800; font-weight: bold } /* Keyword.Constant */
|
||||||
|
.kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
|
||||||
|
.kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
|
||||||
|
.kp { color: #003388; font-weight: bold } /* Keyword.Pseudo */
|
||||||
|
.kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
|
||||||
|
.kt { color: #333399; font-weight: bold } /* Keyword.Type */
|
||||||
|
.m { color: #6600EE; font-weight: bold } /* Literal.Number */
|
||||||
|
.s { background-color: #fff0f0 } /* Literal.String */
|
||||||
|
.na { color: #0000CC } /* Name.Attribute */
|
||||||
|
.nb { color: #007020 } /* Name.Builtin */
|
||||||
|
.nc { color: #BB0066; font-weight: bold } /* Name.Class */
|
||||||
|
.no { color: #003366; font-weight: bold } /* Name.Constant */
|
||||||
|
.nd { color: #555555; font-weight: bold } /* Name.Decorator */
|
||||||
|
.ni { color: #880000; font-weight: bold } /* Name.Entity */
|
||||||
|
.ne { color: #FF0000; font-weight: bold } /* Name.Exception */
|
||||||
|
.nf { color: #0066BB; font-weight: bold } /* Name.Function */
|
||||||
|
.nl { color: #997700; font-weight: bold } /* Name.Label */
|
||||||
|
.nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
|
||||||
|
.nt { color: #007700 } /* Name.Tag */
|
||||||
|
.nv { color: #996633 } /* Name.Variable */
|
||||||
|
.ow { color: #000000; font-weight: bold } /* Operator.Word */
|
||||||
|
.w { color: #bbbbbb } /* Text.Whitespace */
|
||||||
|
.mb { color: #6600EE; font-weight: bold } /* Literal.Number.Bin */
|
||||||
|
.mf { color: #6600EE; font-weight: bold } /* Literal.Number.Float */
|
||||||
|
.mh { color: #005588; font-weight: bold } /* Literal.Number.Hex */
|
||||||
|
.mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
|
||||||
|
.mo { color: #4400EE; font-weight: bold } /* Literal.Number.Oct */
|
||||||
|
.sb { background-color: #fff0f0 } /* Literal.String.Backtick */
|
||||||
|
.sc { color: #0044DD } /* Literal.String.Char */
|
||||||
|
.sd { color: #DD4422 } /* Literal.String.Doc */
|
||||||
|
.s2 { background-color: #fff0f0 } /* Literal.String.Double */
|
||||||
|
.se { color: #666666; font-weight: bold; background-color: #fff0f0 } /* Literal.String.Escape */
|
||||||
|
.sh { background-color: #fff0f0 } /* Literal.String.Heredoc */
|
||||||
|
.si { background-color: #eeeeee } /* Literal.String.Interpol */
|
||||||
|
.sx { color: #DD2200; background-color: #fff0f0 } /* Literal.String.Other */
|
||||||
|
.sr { color: #000000; background-color: #fff0ff } /* Literal.String.Regex */
|
||||||
|
.s1 { background-color: #fff0f0 } /* Literal.String.Single */
|
||||||
|
.ss { color: #AA6600 } /* Literal.String.Symbol */
|
||||||
|
.bp { color: #007020 } /* Name.Builtin.Pseudo */
|
||||||
|
.vc { color: #336699 } /* Name.Variable.Class */
|
||||||
|
.vg { color: #dd7700; font-weight: bold } /* Name.Variable.Global */
|
||||||
|
.vi { color: #3333BB } /* Name.Variable.Instance */
|
||||||
|
.il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
|
||||||
|
|
||||||
|
}
|
||||||
431
docs/css/main.scss
Executable file
431
docs/css/main.scss
Executable file
@ -0,0 +1,431 @@
|
|||||||
|
---
|
||||||
|
# Only the main Sass file needs front matter (the dashes are enough)
|
||||||
|
---
|
||||||
|
@charset "utf-8";
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// Width of the content area
|
||||||
|
$content-width: 700px;
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// Using media queries with like this:
|
||||||
|
// @include media-query($on-palm) {
|
||||||
|
// .wrapper {
|
||||||
|
// padding-right: $spacing-unit / 2;
|
||||||
|
// padding-left: $spacing-unit / 2;
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
@mixin media-query($device) {
|
||||||
|
@media screen and (max-width: $device) {
|
||||||
|
@content;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// Import partials from `sass_dir` (defaults to `_sass`)
|
||||||
|
@import
|
||||||
|
"colors",
|
||||||
|
"mui",
|
||||||
|
"syntax-highlighting"
|
||||||
|
;
|
||||||
|
|
||||||
|
body {
|
||||||
|
padding-top: 93px;
|
||||||
|
}
|
||||||
|
|
||||||
|
i.fa {
|
||||||
|
margin-right: 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.mui-container {
|
||||||
|
max-width: 800px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.site-appbar {
|
||||||
|
background-color: mui-color("indigo", "500");
|
||||||
|
left: 0;
|
||||||
|
margin-bottom: 15px;
|
||||||
|
overflow: auto;
|
||||||
|
padding-left: 10px;
|
||||||
|
padding-top: 10px;
|
||||||
|
position: fixed;
|
||||||
|
right: 0;
|
||||||
|
top: 0;
|
||||||
|
z-index: 6;
|
||||||
|
}
|
||||||
|
|
||||||
|
.site-nav {
|
||||||
|
float: right;
|
||||||
|
list-style: none;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
|
||||||
|
li {
|
||||||
|
display: inline-block;
|
||||||
|
|
||||||
|
a {
|
||||||
|
color: #fff;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.mui-container-fluid {
|
||||||
|
&.post-content {
|
||||||
|
margin: 0 auto;
|
||||||
|
max-width: $content-width;
|
||||||
|
}
|
||||||
|
|
||||||
|
img {
|
||||||
|
display: block;
|
||||||
|
max-width: 100%;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.post-meta {
|
||||||
|
font-size: 18px;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.sharer {
|
||||||
|
float: right;
|
||||||
|
|
||||||
|
.sh-fb {
|
||||||
|
color: #4A65A0;
|
||||||
|
}
|
||||||
|
.sh-twt {
|
||||||
|
color: #0088cc;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.post-content {
|
||||||
|
position: relative;
|
||||||
|
top: 135px;
|
||||||
|
z-index: 3;
|
||||||
|
|
||||||
|
.post-meta {
|
||||||
|
padding: 10px 0 10px 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.article-title {
|
||||||
|
font-size: 45px;
|
||||||
|
font-weight: bold;
|
||||||
|
line-height: 50px;
|
||||||
|
padding-bottom: 10px;
|
||||||
|
transition: all 0.3s ease-in;
|
||||||
|
|
||||||
|
a {
|
||||||
|
color: #111;
|
||||||
|
|
||||||
|
&:hover {
|
||||||
|
color: #08c;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.site-title {
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
color: #FFF;
|
||||||
|
display: inline-block;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.post-list {
|
||||||
|
list-style: none;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
padding-top: 15px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.post-data {
|
||||||
|
padding: 15px;
|
||||||
|
}
|
||||||
|
|
||||||
|
article {
|
||||||
|
&.mui-panel {
|
||||||
|
padding: 0px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.mui-panel {
|
||||||
|
.post-list-title {
|
||||||
|
margin-top: 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
.bg-holder {
|
||||||
|
-moz-background-size: cover;
|
||||||
|
-o-background-size: cover;
|
||||||
|
-webkit-background-size: cover;
|
||||||
|
background-color: mui-color('blue-grey', '500');
|
||||||
|
background-size: cover;
|
||||||
|
min-height: 180px;
|
||||||
|
position: relative;
|
||||||
|
|
||||||
|
a {
|
||||||
|
color: #fff;
|
||||||
|
|
||||||
|
&.overlay {
|
||||||
|
bottom: 0;
|
||||||
|
color: #fff;
|
||||||
|
display: block;
|
||||||
|
left: 0;
|
||||||
|
position: absolute;
|
||||||
|
right: 0;
|
||||||
|
top: 0;
|
||||||
|
z-index: 4;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.img-overlay {
|
||||||
|
bottom: 0;
|
||||||
|
background-color: #000;
|
||||||
|
display: block;
|
||||||
|
left: 0;
|
||||||
|
opacity: 0.5;
|
||||||
|
position: absolute;
|
||||||
|
right: 0;
|
||||||
|
top: 0;
|
||||||
|
z-index: 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
h2 {
|
||||||
|
bottom: 15px;
|
||||||
|
font-size: 34px;
|
||||||
|
font-weight: bold;
|
||||||
|
left: 15px;
|
||||||
|
line-height: 40px;
|
||||||
|
right: 15px;
|
||||||
|
margin: 0;
|
||||||
|
position: absolute;
|
||||||
|
z-index: 3;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.post-full {
|
||||||
|
position: relative;
|
||||||
|
|
||||||
|
.bg-holder {
|
||||||
|
left: 0;
|
||||||
|
min-height: 250px;
|
||||||
|
position: fixed;
|
||||||
|
right: 0;
|
||||||
|
top: 0;
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
bottom: 25px;
|
||||||
|
line-height: 50px;
|
||||||
|
}
|
||||||
|
|
||||||
|
a.overlay {
|
||||||
|
position: fixed;
|
||||||
|
background: #414040;
|
||||||
|
padding: 5px;
|
||||||
|
top: 15px;
|
||||||
|
left: 15px;
|
||||||
|
bottom: initial;
|
||||||
|
right: initial;
|
||||||
|
border-radius: 2px;
|
||||||
|
|
||||||
|
i {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
a:hover {
|
||||||
|
text-decoration : none;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.post-excerpt {
|
||||||
|
font-size: 16px;
|
||||||
|
}
|
||||||
|
.post-tag {
|
||||||
|
background-color: mui-color('indigo','400');
|
||||||
|
color: #fff;
|
||||||
|
display: inline-block;
|
||||||
|
margin-bottom: 1px;
|
||||||
|
padding: 2px 4px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.post-page {
|
||||||
|
h1 {
|
||||||
|
bottom: 15px;
|
||||||
|
font-size: 48px;
|
||||||
|
font-weight: bold;
|
||||||
|
left: 0;
|
||||||
|
margin: 0;
|
||||||
|
position: absolute;
|
||||||
|
text-align: center;
|
||||||
|
width: 100%;
|
||||||
|
z-index: 3;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.post-html {
|
||||||
|
border-top: 1px solid mui-color('blue-grey','400');
|
||||||
|
font-size: 18px;
|
||||||
|
padding-top: 20px;
|
||||||
|
|
||||||
|
p {
|
||||||
|
margin-bottom: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1, h2, h3, h4, h5, h6 {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
pre {
|
||||||
|
@extend .mui-panel;
|
||||||
|
|
||||||
|
code {
|
||||||
|
color: initial;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
code {
|
||||||
|
color: mui-color('red', '500');
|
||||||
|
}
|
||||||
|
|
||||||
|
blockquote {
|
||||||
|
border-left: 2px solid mui-color('teal', '400');
|
||||||
|
margin: 0;
|
||||||
|
padding-left: 15px;
|
||||||
|
}
|
||||||
|
img {
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
article {
|
||||||
|
footer {
|
||||||
|
border-top: 1px solid mui-color('grey', '500');
|
||||||
|
font-size: 18px;
|
||||||
|
padding: 20px 0;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.paginator {
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
.about-links {
|
||||||
|
list-style: none;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
|
||||||
|
.mui-btn {
|
||||||
|
display: block;
|
||||||
|
text-align: left;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.site-footer {
|
||||||
|
text-align: center;
|
||||||
|
background-color: mui-color('grey', '200');
|
||||||
|
}
|
||||||
|
|
||||||
|
.bg-grey {
|
||||||
|
background-color: mui-color('grey', '500');
|
||||||
|
}
|
||||||
|
.bg-orange {
|
||||||
|
background-color: mui-color('orange', '500');
|
||||||
|
a {
|
||||||
|
color: #000;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.bg-yellow {
|
||||||
|
background-color: mui-color('yellow', '500');
|
||||||
|
a {
|
||||||
|
color: #000;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.bg-amber {
|
||||||
|
background-color: mui-color('amber', '500');
|
||||||
|
a {
|
||||||
|
color: #000;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.bg-light-blue {
|
||||||
|
background-color: mui-color('light-blue', '500');
|
||||||
|
}
|
||||||
|
.bg-lime {
|
||||||
|
background-color: mui-color('lime', '500');
|
||||||
|
a {
|
||||||
|
color: #000;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.bg-teal {
|
||||||
|
background-color: mui-color('teal', '500');
|
||||||
|
}
|
||||||
|
.bg-blue {
|
||||||
|
background-color: mui-color('blue', '500');
|
||||||
|
}
|
||||||
|
.bg-black-87 {
|
||||||
|
background-color: mui-color('black-alpha-87');
|
||||||
|
}
|
||||||
|
.bg-blue-grey {
|
||||||
|
background-color: mui-color('blue-grey', '500');
|
||||||
|
}
|
||||||
|
.bg-brown {
|
||||||
|
background-color: mui-color('brown', '500');
|
||||||
|
}
|
||||||
|
.bg-indigo {
|
||||||
|
background-color: mui-color('indigo', '500');
|
||||||
|
}
|
||||||
|
.bg-purple {
|
||||||
|
background-color: mui-color('purple', '500');
|
||||||
|
}
|
||||||
|
.bg-deep-purple {
|
||||||
|
background-color: mui-color('deep-purple', '500');
|
||||||
|
}
|
||||||
|
.bg-red {
|
||||||
|
background-color: mui-color('red', '500');
|
||||||
|
}
|
||||||
|
.bg-pink {
|
||||||
|
background-color: mui-color('pink', '500');
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (max-width: 767px) {
|
||||||
|
.bg-holder {
|
||||||
|
h2 {
|
||||||
|
font-size: 25px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.post-full {
|
||||||
|
.bg-holder {
|
||||||
|
min-height: 200px;
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
bottom: 15px;
|
||||||
|
font-size: 32px;
|
||||||
|
line-height: 32px;
|
||||||
|
}
|
||||||
|
a.overlay {
|
||||||
|
left: initial;
|
||||||
|
right: 15px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
.sharer {
|
||||||
|
display: block;
|
||||||
|
float: none;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (max-width: 480px) {
|
||||||
|
body {
|
||||||
|
padding-top: 82px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.post-full {
|
||||||
|
.bg-holder {
|
||||||
|
min-height: 300px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
34
docs/docs/A.md
Normal file
34
docs/docs/A.md
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
---
|
||||||
|
layout: default
|
||||||
|
---
|
||||||
|
|
||||||
|
# Class A
|
||||||
|
|
||||||
|
This is an example of how to document a class A
|
||||||
|
|
||||||
|
Here is some code
|
||||||
|
```cs
|
||||||
|
class pepe
|
||||||
|
{
|
||||||
|
int pepe() {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Here is a list
|
||||||
|
* one
|
||||||
|
* two
|
||||||
|
* three
|
||||||
|
|
||||||
|
maybe you want a link to [Class B](B)
|
||||||
|
|
||||||
|
It can do tables
|
||||||
|
|
||||||
|
| Tables | Are | Cool |
|
||||||
|
| ------------- |:-------------:| -----:|
|
||||||
|
| col 3 is | right-aligned | $1600 |
|
||||||
|
| col 2 is | centered | $12 |
|
||||||
|
| zebra stripes | are neat | $1 |
|
||||||
|
|
||||||
|
Here is a [cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
|
||||||
5
docs/docs/B.md
Normal file
5
docs/docs/B.md
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
layout: default
|
||||||
|
---
|
||||||
|
|
||||||
|
# Markdown hello from Class B
|
||||||
BIN
docs/img/sharer.png
Normal file
BIN
docs/img/sharer.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.0 KiB |
16
docs/index.md
Normal file
16
docs/index.md
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
layout: default
|
||||||
|
---
|
||||||
|
|
||||||
|
This is an example for documentation.
|
||||||
|
|
||||||
|
Create a document inside docs in markdown.
|
||||||
|
add
|
||||||
|
```
|
||||||
|
---
|
||||||
|
layout:default
|
||||||
|
---
|
||||||
|
```
|
||||||
|
at the top
|
||||||
|
|
||||||
|
then edit `_data/navigation.yml` and add a link to your page
|
||||||
1
docs/js/mui.min.js
vendored
Normal file
1
docs/js/mui.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
76
docs/js/script.js
Normal file
76
docs/js/script.js
Normal file
@ -0,0 +1,76 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
document.addEventListener("DOMContentLoaded", function(event) {
|
||||||
|
|
||||||
|
var cmtBtn = document.getElementById("showComments");
|
||||||
|
if(!cmtBtn){
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var commentHidden = true;
|
||||||
|
var disqus_shortname = '';
|
||||||
|
var dt = document.getElementById("disqus_thread");
|
||||||
|
|
||||||
|
function loadDisqus() {
|
||||||
|
if(disqus_shortname === ''){
|
||||||
|
disqus_shortname = '{{ site.disqus }}';
|
||||||
|
dt.innerHTML = 'Loading comments...';
|
||||||
|
(function() {
|
||||||
|
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
|
||||||
|
dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
|
||||||
|
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
|
||||||
|
})();
|
||||||
|
}
|
||||||
|
if(commentHidden){
|
||||||
|
dt.setAttribute('style','display:block');
|
||||||
|
this.innerHTML = 'Hide Comments';
|
||||||
|
}else{
|
||||||
|
dt.setAttribute('style','display:none');
|
||||||
|
this.innerHTML = 'Comments';
|
||||||
|
}
|
||||||
|
commentHidden = !commentHidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
cmtBtn.addEventListener("click", function(e){
|
||||||
|
e.preventDefault();
|
||||||
|
loadDisqus();
|
||||||
|
});
|
||||||
|
|
||||||
|
var scrolling = false;
|
||||||
|
|
||||||
|
function isElementInViewport (el) {
|
||||||
|
if (typeof jQuery === "function" && el instanceof jQuery) {
|
||||||
|
el = el[0];
|
||||||
|
}
|
||||||
|
|
||||||
|
var rect = el.getBoundingClientRect();
|
||||||
|
|
||||||
|
scrolling = false;
|
||||||
|
return (
|
||||||
|
rect.top >= 0 &&
|
||||||
|
rect.left >= 0 &&
|
||||||
|
rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
|
||||||
|
rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function enableScrolling(e) {
|
||||||
|
scrolling = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
window.addEventListener('scroll', enableScrolling);
|
||||||
|
|
||||||
|
var interval = setInterval(function() {
|
||||||
|
if(!scrolling) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
if(isElementInViewport(cmtBtn)) {
|
||||||
|
loadDisqus();
|
||||||
|
clearInterval(interval);
|
||||||
|
window.removeEventListener('scroll', enableScrolling);
|
||||||
|
}
|
||||||
|
}, 400);
|
||||||
|
});
|
||||||
8
docs/robots.txt
Normal file
8
docs/robots.txt
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
---
|
||||||
|
---
|
||||||
|
# www.robotstxt.org/
|
||||||
|
|
||||||
|
# Allow crawling of all content
|
||||||
|
User-agent: *
|
||||||
|
Disallow:
|
||||||
|
Sitemap: {{ site.base_url }}/sitemap.xml
|
||||||
27
docs/sitemap.xml
Normal file
27
docs/sitemap.xml
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
---
|
||||||
|
---
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<urlset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd" xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
||||||
|
{% for post in site.posts %}
|
||||||
|
<url>
|
||||||
|
<loc>{{ post.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}</loc>
|
||||||
|
{% if post.lastmod == null %}
|
||||||
|
<lastmod>{{ post.date | date_to_xmlschema }}</lastmod>
|
||||||
|
{% else %}
|
||||||
|
<lastmod>{{ post.lastmod | date_to_xmlschema }}</lastmod>
|
||||||
|
{% endif %}
|
||||||
|
<changefreq>weekly</changefreq>
|
||||||
|
<priority>0.9</priority>
|
||||||
|
</url>
|
||||||
|
{% endfor %}
|
||||||
|
{% for page in site.pages %}
|
||||||
|
{% if page.sitemap != null and page.sitemap != empty %}
|
||||||
|
<url>
|
||||||
|
<loc>{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}</loc>
|
||||||
|
<lastmod>{{ page.sitemap.lastmod | date_to_xmlschema }}</lastmod>
|
||||||
|
<changefreq>{{ page.sitemap.changefreq }}</changefreq>
|
||||||
|
<priority>{{ page.sitemap.priority }}</priority>
|
||||||
|
</url>
|
||||||
|
{% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
</urlset>
|
||||||
Loading…
Reference in New Issue
Block a user