You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ad...@apache.org on 2016/01/06 22:37:04 UTC
[10/10] incubator-mynewt-site git commit: new look for website with a
logo and additional tabs, but docs need more format change
new look for website with a logo and additional tabs, but docs need more format change
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/4c2d2384
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/4c2d2384
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/4c2d2384
Branch: refs/heads/master
Commit: 4c2d23849da789979fe20520d1d7bf8338fe2a2a
Parents: 0d1d4fc
Author: aditihilbert <ad...@runtime.io>
Authored: Wed Jan 6 13:36:29 2016 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Wed Jan 6 13:36:29 2016 -0800
----------------------------------------------------------------------
custom-theme/base.html | 96 ++
custom-theme/breadcrumbs.html | 25 +
custom-theme/community.html | 115 ++
custom-theme/content.html | 9 +
custom-theme/css/base.css | 109 ++
custom-theme/css/bootstrap-3.0.3.min.css | 7 +
custom-theme/css/custom.css | 621 ++++++++
custom-theme/css/font-awesome-4.0.3.css | 1338 ++++++++++++++++++
custom-theme/css/highlight.css | 125 ++
custom-theme/documentation.html | 39 +
custom-theme/download.html | 86 ++
custom-theme/events.html | 22 +
custom-theme/fonts/fontawesome-webfont.eot | Bin 0 -> 38205 bytes
custom-theme/fonts/fontawesome-webfont.svg | 414 ++++++
custom-theme/fonts/fontawesome-webfont.ttf | Bin 0 -> 80652 bytes
custom-theme/fonts/fontawesome-webfont.woff | Bin 0 -> 44432 bytes
custom-theme/footer.html | 26 +
custom-theme/img/01.png | Bin 0 -> 9109 bytes
custom-theme/img/apache-feather.png | Bin 0 -> 11402 bytes
custom-theme/img/apache-logo.png | Bin 0 -> 8585 bytes
custom-theme/img/asf_logo_wide.gif | Bin 0 -> 7051 bytes
custom-theme/img/content-bg.png | Bin 0 -> 155 bytes
custom-theme/img/egg-logo.png | Bin 0 -> 8626 bytes
custom-theme/img/favicon.ico | Bin 0 -> 1150 bytes
custom-theme/img/folder.png | Bin 0 -> 8414 bytes
custom-theme/img/logo.svg | 1652 ++++++++++++++++++++++
custom-theme/img/performance.png | Bin 0 -> 9850 bytes
custom-theme/img/watch.png | Bin 0 -> 10328 bytes
custom-theme/js/base.js | 20 +
custom-theme/js/bootstrap-3.0.3.min.js | 7 +
custom-theme/js/custom.js | 16 +
custom-theme/js/highlight.pack.js | 2 +
custom-theme/js/jquery-1.10.2.min.js | 6 +
custom-theme/landing.html | 86 ++
custom-theme/main-banner.html | 8 +
custom-theme/nav.html | 56 +
custom-theme/search.html | 19 +
custom-theme/toc.html | 30 +
docs/community.md | 7 +
docs/documentation.md | 3 +
docs/download.md | 13 +
docs/events.md | 3 +
docs/extra.css | 26 -
docs/index.md | 98 +-
images/01.png | Bin 0 -> 9109 bytes
images/apache-feather.png | Bin 0 -> 11402 bytes
images/apache-logo.png | Bin 0 -> 8585 bytes
images/folder.png | Bin 0 -> 8414 bytes
images/logo-large.png | Bin 0 -> 16698 bytes
images/logo-small.png | Bin 0 -> 3771 bytes
images/logo.svg | 106 ++
images/performance.png | Bin 0 -> 9850 bytes
images/watch.png | Bin 0 -> 10328 bytes
mkdocs.yml | 47 +-
54 files changed, 5103 insertions(+), 134 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/4c2d2384/custom-theme/base.html
----------------------------------------------------------------------
diff --git a/custom-theme/base.html b/custom-theme/base.html
new file mode 100644
index 0000000..d67341a
--- /dev/null
+++ b/custom-theme/base.html
@@ -0,0 +1,96 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <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_description %}<meta name="description" content="{{ page_description }}">{% endif %}
+ {% if site_author %}<meta name="author" content="{{ site_author }}">{% endif %}
+ {% if canonical_url %}<link rel="canonical" href="{{ canonical_url }}">{% endif %}
+ {% if favicon %}<link rel="shortcut icon" href="{{ favicon }}">
+ {% else %}<link rel="shortcut icon" href="{{ base_url }}/img/favicon.ico">{% endif %}
+
+ <title>{% if page_title %}{{ page_title }} - {% endif %}{{ site_name }}</title>
+
+ <link href="{{ base_url }}/css/bootstrap-3.0.3.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">
+ <link href="{{ base_url }}/css/custom.css" rel="stylesheet">
+ <link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
+ {%- for path in extra_css %}
+ <link href="{{ path }}" rel="stylesheet">
+ {%- endfor %}
+
+ <!-- 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.3.0/respond.min.js"></script>
+ <![endif]-->
+
+ {% if 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', '{{ google_analytics[0] }}', '{{ google_analytics[1] }}');
+ ga('send', 'pageview');
+ </script>
+ {% endif %}
+ </head>
+
+{% if page_title != None %}
+ <body class="{{ page_title }}">
+{% else %}
+ <body class="home">
+{% endif %}
+
+ {% include "nav.html" %}
+
+ <div class="container-fluid">
+ {% if page_title == None %}
+ {% include "landing.html" %}
+ {% elif page_title == 'Documentation' %}
+ {% include "documentation.html" %}
+ {% elif page_title == 'Download' %}
+ {% include "download.html" %}
+ {% elif page_title == 'Community' %}
+ {% include "community.html" %}
+ {% elif page_title == 'Events' %}
+ {% include "events.html" %}
+ {% else %}
+ <div class="row sm-extra-padding">
+ <div class="col-md-3 bg-grey sidebar-container">{% include "toc.html" %}</div>
+
+ <div class="show-sidebar-container">
+ <button class="show-sidebar">Docs Menu</button>
+ </div>
+
+ <div class="col-md-9 documentation-viewer" role="main">
+ {% include 'breadcrumbs.html' %}
+ {% block content %}
+ {{ content }}
+ {% endblock %}
+ </div>
+ </div>
+ {% endif %}
+ <div class="row">
+ {% include 'footer.html' %}
+ </div>
+ </div>
+
+ <script src="{{ base_url }}/js/jquery-1.10.2.min.js"></script>
+ <script src="{{ base_url }}/js/bootstrap-3.0.3.min.js"></script>
+ <script src="{{ base_url }}/js/highlight.pack.js"></script>
+ <script src="{{ base_url }}/js/base.js"></script>
+ <script src="{{ base_url }}/js/custom.js"></script>
+
+ {%- for path in extra_javascript %}
+ <script src="{{ path }}"></script>
+ {%- endfor %}
+
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/4c2d2384/custom-theme/breadcrumbs.html
----------------------------------------------------------------------
diff --git a/custom-theme/breadcrumbs.html b/custom-theme/breadcrumbs.html
new file mode 100644
index 0000000..01960e6
--- /dev/null
+++ b/custom-theme/breadcrumbs.html
@@ -0,0 +1,25 @@
+<div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="{{ homepage_url }}">Docs</a> »</li>
+ {% if current_page %}
+ {% for doc in current_page.ancestors %}
+ {% if doc.link %}
+ <li><a href="{{ doc.link|e }}">{{ doc.title }}</a> »</li>
+ {% else %}
+ <li>{{ doc.title }} »</li>
+ {% endif %}
+ {% endfor %}
+ {% endif %}
+ {% if current_page %}<li>{{ current_page.title }}</li>{% endif %}
+ <li class="wy-breadcrumbs-aside">
+ {% if repo_url %}
+ {% if repo_name == 'GitHub' %}
+ <a href="{{ repo_url }}" class="icon icon-github"> Edit on GitHub</a>
+ {% elif repo_name == 'Bitbucket' %}
+ <a href="{{ repo_url }}" class="icon icon-bitbucket"> Edit on BitBucket</a>
+ {% endif %}
+ {% endif %}
+ </li>
+ </ul>
+ <hr/>
+</div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/4c2d2384/custom-theme/community.html
----------------------------------------------------------------------
diff --git a/custom-theme/community.html b/custom-theme/community.html
new file mode 100644
index 0000000..c060f54
--- /dev/null
+++ b/custom-theme/community.html
@@ -0,0 +1,115 @@
+{% include 'main-banner.html' %}
+<div class="container small-no-padding">
+ <div class="row content">
+ <div class="col-md-12">
+ {% block content %} {{ content }} {% endblock %}
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-6 mailing-list">
+ <div class="bg-purple mailing-list-title">
+ Dev Mailing List
+ </div>
+ <div class="list-info">
+ <p><a class="bold-link" href="mailto:dev@mynewt.incubator.apache.org">dev@mynewt.incubator.apache.org</a></p>
+ <p>For both contributors and users.</p>
+ </div>
+ <div class="bg-grey subscribe">
+ Subscribe
+ </div>
+ <div class="list-info">
+ <p><a href="mailto:dev-subscribe@mynewt.incubator.apache.org">dev-subscribe@mynewt.incubator.apache.org</a></p>
+ </div>
+ <div class="bg-grey subscribe">
+ Unsubscribe
+ </div>
+ <div class="list-info">
+ <p><a href="mailto:dev-unsubscribe@mynewt.incubator.apache.org">dev-unsubscribe@mynewt.incubator.apache.org</a></p>
+ </div>
+ </div>
+ <div class="col-md-6 mailing-list">
+ <div class="bg-purple mailing-list-title">
+ Commits Mailing List
+ </div>
+ <div class="list-info">
+ <p><a class="bold-link" href="mailto:commits@mynewt.incubator.apache.org">commits@mynewt.incubator.apache.org</a></p>
+ <p>Mainly for contributors to code or documentation.</p>
+ </div>
+ <div class="bg-grey subscribe">
+ Subscribe
+ </div>
+ <div class="list-info">
+ <p><a href="mailto:commits-subscribe@mynewt.incubator.apache.org">commits-subscribe@mynewt.incubator.apache.org</a></p>
+ </div>
+ <div class="bg-grey subscribe">
+ Unsubscribe
+ </div>
+ <div class="list-info">
+ <p><a href="mailto:commits-unsubscribe@mynewt.incubator.apache.org">commits-unsubscribe@mynewt.incubator.apache.org</a></p>
+ </div>
+ </div>
+ </div>
+ <div class="row">
+ <div class="col-md-6 mailing-list">
+ <div class="bg-purple mailing-list-title">
+ Notifications Mailing List
+ </div>
+ <div class="list-info">
+ <p><a class="bold-link" href="mailto:notifications@mynewt.incubator.apache.org">notifications@mynewt.incubator.apache.org</a></p>
+ <p>For all autogenerated mail except commits e.g. JIRA notifications.</p>
+ </div>
+ <div class="bg-grey subscribe">
+ Subscribe
+ </div>
+ <div class="list-info">
+ <p><a href="mailto:notifications-subscribe@mynewt.incubator.apache.org">notifications-subscribe@mynewt.incubator.apache.org</a></p>
+ </div>
+ <div class="bg-grey subscribe">
+ Unsubscribe
+ </div>
+ <div class="list-info">
+ <p><a href="mailto:notifications-unsubscribe@mynewt.incubator.apache.org">notifications-unsubscribe@mynewt.incubator.apache.org</a></p>
+ </div>
+ </div>
+ <div class="col-md-6 mailing-list">
+ <div class="bg-purple mailing-list-title">
+ Issue Tracking Mailing List
+ </div>
+ <div class="list-info">
+ <p><a class="bold-link" href="mailto:issues@mynewt.incubator.apache.org">issues@mynewt.incubator.apache.org</a></p>
+ <p>For all known issues.</p>
+ </div>
+ <div class="bg-grey subscribe">
+ Subscribe
+ </div>
+ <div class="list-info">
+ <p><a href="mailto:issues-subscribe@mynewt.incubator.apache.org">issues-subscribe@mynewt.incubator.apache.org</a></p>
+ </div>
+ <div class="bg-grey subscribe">
+ Unsubscribe
+ </div>
+ <div class="list-info">
+ <p><a href="mailto:issues-unsubscribe@mynewt.incubator.apache.org">issues-unsubscribe@mynewt.incubator.apache.org</a></p>
+ </div>
+ </div>
+ </div>
+</div>
+<div class="bg-orange padded">
+ <div class="container">
+ <div class="row">
+ <div class="col-md-12">
+ <h2>Contributing</h2>
+ <p>All content on this site is statically generated using MkDocs from documents written in Markdown and stored in the docs directory on the master branch in the Documentation repository. As a documentation contributor you will modify the desired markdown file or create new ones in the appropriate chapter subdirectory under docs.</p>
+ <p>To edit content in a Markdown file and be able to see how the changes look you may use desktop apps such as:</p>
+ <ul>
+ <li><a target="_blank" href="http://25.io/mou/">Mou</a> for Mac</li>
+ <li><a target="_blank" href="http://alternativeto.net/software/mou/?platform=windows">Something like Mou</a> for Windows</li>
+ </ul>
+ <p>
+ Click on the tutorial How to edit docs under "Get Started" to learn how to edit a sample file try_markdown.md on Mynewt's documentation git repository. The static html content is generated and maintained in the asf-site branch in the documentation repository. Currently, the static html files are generated manually once a day. This will be automated in the future.
+ <br> If you wish, you may preview the changes you have made on your desktop by installing MkDocs and starting up its builtin webserver as described in MkDocs. This step is optional but described in the tutorial.
+ </p>
+ </div>
+ </div>
+ </div>
+</div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/4c2d2384/custom-theme/content.html
----------------------------------------------------------------------
diff --git a/custom-theme/content.html b/custom-theme/content.html
new file mode 100644
index 0000000..b578f1a
--- /dev/null
+++ b/custom-theme/content.html
@@ -0,0 +1,9 @@
+{% if meta.source %}
+ <div class="source-links">
+ {% for filename in meta.source %}
+ <span class="label label-primary">{{ filename }}</span>
+ {% endfor %}
+ </div>
+{% endif %}
+
+{{ content }}
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/4c2d2384/custom-theme/css/base.css
----------------------------------------------------------------------
diff --git a/custom-theme/css/base.css b/custom-theme/css/base.css
new file mode 100644
index 0000000..08eeb9a
--- /dev/null
+++ b/custom-theme/css/base.css
@@ -0,0 +1,109 @@
+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-9 {
+ padding-bottom: 100px;
+}
+
+div.source-links {
+ float: right;
+}
+
+/*
+ * 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;
+ }
+}