new common layout for pages, add common layout to connect page to update styling

This commit is contained in:
Justin Cooper 2021-12-01 09:52:50 -06:00
parent 25ff6fc1e6
commit 787b8ddc43
7 changed files with 273 additions and 274 deletions

9
_layouts/common.html Normal file
View file

@ -0,0 +1,9 @@
---
layout: default
---
<div id="libraries-page" class="common-layout">
<div class="content">
{{ content }}
</div>
</div>

View file

@ -1,59 +1,57 @@
---
layout: default
layout: common
---
<!-- https://github.com/adafruit/circuitpython/issues/1246 -->
<div id="libraries-page" class="common-layout">
<div class="content">
<h1>Contributing</h1>
<p>
If you'd like to contribute to the CircuitPython project, the CircuitPython
libraries are a great way to begin. This page is updated with daily status
information from the CircuitPython libraries, including open pull requests,
open issues and library infrastructure issues.
</p>
<p>
Do you write a language other than English? Another great way to contribute
to the project is to contribute new localizations (translations) of
CircuitPython, or update current localizations, using
<a href="https://hosted.weblate.org/engage/circuitpython/">Weblate</a>.
</p>
<p>
If this is your first time contributing, or you'd
like to see our recommended contribution workflow, we have a guide on
<a href="https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github">Contributing to CircuitPython with Git and Github</a>.
You can also find us in the #circuitpython channel on the
<a href="https://adafru.it/discord">Adafruit Discord</a>.
</p>
<p>
Have an idea for a new driver or library?
<a href="https://github.com/adafruit/circuitpython/issues">File an issue on the CircuitPython repo!</a>
</p>
<h2>Current Status for {{ site.data.libraries.updated_at | date: "%a, %b %d, %Y" }}</h2>
<div id="libraries-page">
<h1>Contributing</h1>
<p>
If you'd like to contribute to the CircuitPython project, the CircuitPython
libraries are a great way to begin. This page is updated with daily status
information from the CircuitPython libraries, including open pull requests,
open issues and library infrastructure issues.
</p>
<p>
Do you write a language other than English? Another great way to contribute
to the project is to contribute new localizations (translations) of
CircuitPython, or update current localizations, using
<a href="https://hosted.weblate.org/engage/circuitpython/">Weblate</a>.
</p>
<p>
If this is your first time contributing, or you'd
like to see our recommended contribution workflow, we have a guide on
<a href="https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github">Contributing to CircuitPython with Git and Github</a>.
You can also find us in the #circuitpython channel on the
<a href="https://adafru.it/discord">Adafruit Discord</a>.
</p>
<p>
Have an idea for a new driver or library?
<a href="https://github.com/adafruit/circuitpython/issues">File an issue on the CircuitPython repo!</a>
</p>
<h2>Current Status for {{ site.data.libraries.updated_at | date: "%a, %b %d, %Y" }}</h2>
{% assign current = page.url | downcase | split: '/' %}
<ul class='tabbed-navigation'>
<li>
<a href="/contributing" {% if current[2] ==
nil %}class='active'{% endif %}>Pull Requests</a>
</li>
<li>
<a href="/contributing/open-issues" {% if current[2] ==
'open-issues' %}class='active'{% endif %}>Open Issues</a>
</li>
<li>
<a href="/contributing/library-infrastructure-issues" {% if
current[2] ==
'library-infrastructure-issues' %}class='active'{% endif %}>Library Infrastructure Issues</a>
</li>
<li>
<a href="/contributing/weblate" {% if current[2] ==
'weblate' %}class='active'{% endif %}>CircuitPython Localization</a>
</li>
</ul>
<div class="clear"></div>
{{ content }}
</div>
{% assign current = page.url | downcase | split: '/' %}
<ul class='tabbed-navigation'>
<li>
<a href="/contributing" {% if current[2] ==
nil %}class='active'{% endif %}>Pull Requests</a>
</li>
<li>
<a href="/contributing/open-issues" {% if current[2] ==
'open-issues' %}class='active'{% endif %}>Open Issues</a>
</li>
<li>
<a href="/contributing/library-infrastructure-issues" {% if
current[2] ==
'library-infrastructure-issues' %}class='active'{% endif %}>Library Infrastructure Issues</a>
</li>
<li>
<a href="/contributing/weblate" {% if current[2] ==
'weblate' %}class='active'{% endif %}>CircuitPython Localization</a>
</li>
</ul>
<div class="clear"></div>
{{ content }}
</div>
<script src="/assets/javascript/contributing.js"></script>

View file

@ -1,53 +1,51 @@
#libraries-page {
.content {
h1 {
text-align: center;
}
p {
margin-bottom: 16px;
}
h2 {
border-bottom: 1px solid $gray-border;
padding-bottom: .3em;
margin-bottom: 16px;
margin-top: 24px;
}
ul {
margin-bottom: 16px;
li {
margin-top: .25em;
}
}
h1 {
text-align: center;
}
.release-section {
margin-left: 20px;
p {
margin-bottom: 16px;
}
.tabbed-navigation {
list-style: none;
padding: 0;
margin: 0;
width: 100%;
background: white;
h2 {
border-bottom: 1px solid $gray-border;
padding-bottom: .3em;
margin-bottom: 16px;
margin-top: 24px;
}
ul {
margin-bottom: 16px;
li {
float: left;
margin: 0 1em 0 0;
margin-top: .25em;
}
}
}
a {
display: block;
text-decoration: none;
padding: 0.5em 0.5em;
font-weight: bold;
border-bottom: 0.5em solid $gray-border;
.release-section {
margin-left: 20px;
}
&.active {
border-color: #000;
}
.tabbed-navigation {
list-style: none;
padding: 0;
margin: 0;
width: 100%;
background: white;
li {
float: left;
margin: 0 1em 0 0;
a {
display: block;
text-decoration: none;
padding: 0.5em 0.5em;
font-weight: bold;
border-bottom: 0.5em solid $gray-border;
&.active {
border-color: #000;
}
}
}

View file

@ -1,12 +1,10 @@
---
layout: home
layout: common
title: Awesome
permalink: /awesome
---
<div id="awesome-page" class="common-layout">
<div class="content">
{% capture awesome_include %}{% include_relative awesome-circuitpython/README.md %}{% endcapture %}
{{ awesome_include | markdownify }}
<div>
<div id="awesome-page">
{% capture awesome_include %}{% include_relative awesome-circuitpython/README.md %}{% endcapture %}
{{ awesome_include | markdownify }}
</div>

View file

@ -1,5 +1,5 @@
---
layout: default
layout: common
---
# Overview

View file

@ -1,13 +1,11 @@
---
layout: default
layout: common
title: Libraries
permalink: /libraries/contributing
redirect_to: /contributing
---
<div id="libraries-page" class="common-layout">
<div class="content">
<p>This page has moved to <a href="/contributing">the dedicated contributing
page</a>.
</p>
</div>
<div id="libraries-page">
<p>This page has moved to <a href="/contributing">the dedicated contributing
page</a>.
</p>
</div>

View file

@ -1,185 +1,183 @@
---
layout: default
layout: common
title: Libraries
permalink: /libraries
---
<div id="libraries-page" class="common-layout">
<div class="content">
<h1>CircuitPython Libraries</h1>
<div id="libraries-page">
<h1>CircuitPython Libraries</h1>
<p>
The CircuitPython Library Bundle contains all current libraries available for
CircuitPython. They are designed for use with CircuitPython and may or may not
work with MicroPython. The bundle options are explained below.
<p>
CircuitPython libraries are written in Python. They provide additional functionality
and support external devices, beyond what is in CircuitPython itself.
Libraries are stored on your <b>CIRCUITPY</b> drive in a folder called <b>lib</b>.
For more information on using and managing libraries, see the
<a href="https://learn.adafruit.com/welcome-to-circuitpython/circuitpython-libraries">Welcome To CircuitPython Guide</a>.
</p>
<section>
<h2>Documentation</h2>
<p>
The CircuitPython Library Bundle contains all current libraries available for
CircuitPython. They are designed for use with CircuitPython and may or may not
work with MicroPython. The bundle options are explained below.
The
<a href="https://circuitpython.readthedocs.io/projects/bundle/en/latest/drivers.html" title="">libraries documentation page</a>
contains a categorized list of all the CircuitPython libraries included in the following bundles,
with links to the documentation for every library.
<h2>Download and Installation Instructions</h2>
<p>
CircuitPython libraries are written in Python. They provide additional functionality
and support external devices, beyond what is in CircuitPython itself.
Libraries are stored on your <b>CIRCUITPY</b> drive in a folder called <b>lib</b>.
For more information on using and managing libraries, see the
<a href="https://learn.adafruit.com/welcome-to-circuitpython/circuitpython-libraries">Welcome To CircuitPython Guide</a>.
You can download all the available libraries in a zip-file bundle for all recent major
versions of CircuitPython. These bundles are updated daily, whenever any included library is updated.
</p>
<section>
<h2>Documentation</h2>
<p>
The
<a href="https://circuitpython.readthedocs.io/projects/bundle/en/latest/drivers.html" title="">libraries documentation page</a>
contains a categorized list of all the CircuitPython libraries included in the following bundles,
with links to the documentation for every library.
<h2>Download and Installation Instructions</h2>
<p>
You can download all the available libraries in a zip-file bundle for all recent major
versions of CircuitPython. These bundles are updated daily, whenever any included library is updated.
</p>
<p>
The libraries in each release are supplied as <b>.mpy</b> files, which are compiled
versions of Python source code.
<strong>Make sure to download the bundle that matches the major version
of your CircuitPython</strong>, because the <b>.mpy</b> files can change between versions.
For example, if you are running 6.3.0 you should download the 6.x bundle.
</p>
<p>
The precompiled <b>.mpy</b> files take up less space on your CIRCUITPY drive than the <b>.py</b> files.
They also load faster, and for some low-RAM boards, are required because the <b>.py</b> files
are too large to compile on the board itself.
<strong>Unless you need the source version, choose the appropiate <b>.mpy</b> library bundle!</strong>
If you need to compile <b>.py</b> files to <b>.mpy</b>, you can
<a href="https://learn.adafruit.com/welcome-to-circuitpython/frequently-asked-questions#how-can-i-create-my-own-mpy-files-3020687-11">run the <b>mpy-cross</b>
cross-compiler yourself</a>.
</p>
<p>
<b>To install</b>, download the appropriate bundle for your version of CircuitPython.
Unzip the file, open the resulting folder and find the <b>lib</b> folder. Open the lib
folder and find the library files you need to load. Create a <b>lib</b> folder on your
CIRCUITPY drive. Copy the individual library files you need to the <b>lib</b> folder
on your CIRCUITPY drive. More details are available
<a href="https://learn.adafruit.com/welcome-to-circuitpython/circuitpython-libraries">here</a>.
</p>
<p>
You can always find the
<a href="https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/latest">latest releases of the libraries bundle</a>
on GitHub.
</p>
<p>
An alternative way to download and update libraries on your board is to use the
<a href="https://learn.adafruit.com/keep-your-circuitpython-libraries-on-devices-up-to-date-with-circup">CircUp tool</a>,
which is under development.
</p>
</section>
<section>
<h2>Bundles</h2>
<div class="release-section">
<div id="adafruit-circuitpython-bundle-6.x-mpy">
<h3>Bundle for Version 6.x</h3>
<p>
This bundle is built for use with CircuitPython 6.x.x. If you are using
CircuitPython 6, please download this bundle.
</p>
</div>
<div id="adafruit-circuitpython-bundle-7.x-mpy">
<h3>Bundle for Version 7.x</h3>
<p>
This bundle is built for use with CircuitPython 7.x.x. If you are using
CircuitPython 7, please download this bundle. The .mpy format has
changed for CircuitPython 7; 6.x .mpy files are not compatible.
</p>
</div>
<div id="adafruit-circuitpython-bundle-py">
<h3>Python Source Bundle</h3>
<p>
This bundle is the uncompiled Python source code for every library. It is not
intended for general use! It is only recommended if you need to edit
a library file. This bundle works with all supported versions of CircuitPython.
</p>
</div>
<div id="adafruit-circuitpython-bundle-examples">
<h3>Examples Bundle</h3>
<p>
Every CircuitPython library has examples to go along with it. This bundle
contains every library example. This bundle will have examples that
require the latest version of CircuitPython, and therefore contains files
that may not work with all versions.
</p>
</div>
</div>
</section>
<section>
<h2>The Community Bundle</h2>
<p>
The libraries in the bundles above are officially supported by Adafruit.
Additional libraries written and supported by community members are available in the
<a href="https://github.com/adafruit/CircuitPython_Community_Bundle/">Community Bundle</a>.
<p>
The libraries in each release are supplied as <b>.mpy</b> files, which are compiled
versions of Python source code.
<strong>Make sure to download the bundle that matches the major version
of your CircuitPython</strong>, because the <b>.mpy</b> files can change between versions.
For example, if you are running 6.3.0 you should download the 6.x bundle.
</p>
<p>
The precompiled <b>.mpy</b> files take up less space on your CIRCUITPY drive than the <b>.py</b> files.
They also load faster, and for some low-RAM boards, are required because the <b>.py</b> files
are too large to compile on the board itself.
<strong>Unless you need the source version, choose the appropiate <b>.mpy</b> library bundle!</strong>
If you need to compile <b>.py</b> files to <b>.mpy</b>, you can
<a href="https://learn.adafruit.com/welcome-to-circuitpython/frequently-asked-questions#how-can-i-create-my-own-mpy-files-3020687-11">run the <b>mpy-cross</b>
cross-compiler yourself</a>.
</p>
<p>
<b>To install</b>, download the appropriate bundle for your version of CircuitPython.
Unzip the file, open the resulting folder and find the <b>lib</b> folder. Open the lib
folder and find the library files you need to load. Create a <b>lib</b> folder on your
CIRCUITPY drive. Copy the individual library files you need to the <b>lib</b> folder
on your CIRCUITPY drive. More details are available
<a href="https://learn.adafruit.com/welcome-to-circuitpython/circuitpython-libraries">here</a>.
</p>
<p>
You can always find the
<a href="https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/latest">latest releases of the libraries bundle</a>
on GitHub.
</p>
<p>
An alternative way to download and update libraries on your board is to use the
<a href="https://learn.adafruit.com/keep-your-circuitpython-libraries-on-devices-up-to-date-with-circup">CircUp tool</a>,
which is under development.
</p>
</section>
<section>
<h2>Bundles</h2>
<div class="release-section">
<div id="adafruit-circuitpython-bundle-6.x-mpy">
<h3>Bundle for Version 6.x</h3>
<p>
This bundle is built for use with CircuitPython 6.x.x. If you are using
CircuitPython 6, please download this bundle.
</p>
<p>If you are looking for the 6.x Community Bundle, you can find it on
<a href="https://github.com/adafruit/CircuitPython_Community_Bundle/releases/">GitHub</a>.
</p>
<div class="release-section">
<div id="circuitpython-community-bundle-7.x-mpy">
</div>
<div id="adafruit-circuitpython-bundle-7.x-mpy">
<h3>Bundle for Version 7.x</h3>
<p>
This bundle is built for use with CircuitPython 7.x.x. If you are using
CircuitPython 7, please download this bundle.
This bundle is built for use with CircuitPython 7.x.x. If you are using
CircuitPython 7, please download this bundle. The .mpy format has
changed for CircuitPython 7; 6.x .mpy files are not compatible.
</p>
</div>
<div id="circuitpython-community-bundle-py">
<h3>Python Source Bundle</h3>
<p>
This bundle is the uncompiled Python source code for every community library. It is not
intended for general use! It is only recommended if you need to edit
a library file. This bundle works with all supported versions of CircuitPython.
</p>
</div>
</div>
</section>
<section>
<h2>Contributing</h2>
<p>
If you'd like to contribute to the CircuitPython project, the CircuitPython
libraries are a great way to begin. Everyone is welcome to contribute!
Regardless of your experience level, we have many resources to get you
started. Check out the Contributing page for detailed information!
</p>
<p>
Find out more about how you can
<a href="{{ "/contributing" | relative_url }}" title="Contributing Page">contribute to CircuitPython libraries</a>.
</p>
<h2>Library Activity for Week of {{ site.data.libraries.updated_at | date: "%a, %b %d, %Y" }}</h2>
<p>
Thank you to all of our contributors!
</p>
<p>
This week there were {{ site.data.libraries.merged_pr_count }} pull requests merged:
<ul>
<li>
Authors:
{% for contributor in site.data.libraries.contributors %}
<a href="https://github.com/{{contributor}}" title="Contributor Name">{{contributor}}</a>{% if forloop.last != true %}, {% endif %}
{% endfor %}
</li>
<li>
Reviewers:
{% for reviewer in site.data.libraries.reviewers %}
<a href="https://github.com/{{reviewer}}" title="Contributor Name">{{reviewer}}</a>{% if forloop.last != true %}, {% endif %}
{% endfor %}
</li>
</ul>
</p>
<div class="libraries new">
<h3>New Libraries</h3>
<ul>
{% for library in site.data.libraries.library_updates.new %}
<li><a href="{{library[1]}}" title="New Library Location">{{library[0]}}</a></li>
{% endfor %}
</ul>
<div id="adafruit-circuitpython-bundle-py">
<h3>Python Source Bundle</h3>
<p>
This bundle is the uncompiled Python source code for every library. It is not
intended for general use! It is only recommended if you need to edit
a library file. This bundle works with all supported versions of CircuitPython.
</p>
</div>
<div class="libraries updated">
<h3>Updated Libraries</h3>
<ul>
{% for library in site.data.libraries.library_updates.updated %}
<li><a href="{{library[1]}}" title="Updated Library Location">{{library[0]}}</a></li>
{% endfor %}
</ul>
<div id="adafruit-circuitpython-bundle-examples">
<h3>Examples Bundle</h3>
<p>
Every CircuitPython library has examples to go along with it. This bundle
contains every library example. This bundle will have examples that
require the latest version of CircuitPython, and therefore contains files
that may not work with all versions.
</p>
</div>
</section>
</div>
</div>
</section>
<section>
<h2>The Community Bundle</h2>
<p>
The libraries in the bundles above are officially supported by Adafruit.
Additional libraries written and supported by community members are available in the
<a href="https://github.com/adafruit/CircuitPython_Community_Bundle/">Community Bundle</a>.
</p>
<p>If you are looking for the 6.x Community Bundle, you can find it on
<a href="https://github.com/adafruit/CircuitPython_Community_Bundle/releases/">GitHub</a>.
</p>
<div class="release-section">
<div id="circuitpython-community-bundle-7.x-mpy">
<h3>Bundle for Version 7.x</h3>
<p>
This bundle is built for use with CircuitPython 7.x.x. If you are using
CircuitPython 7, please download this bundle.
</p>
</div>
<div id="circuitpython-community-bundle-py">
<h3>Python Source Bundle</h3>
<p>
This bundle is the uncompiled Python source code for every community library. It is not
intended for general use! It is only recommended if you need to edit
a library file. This bundle works with all supported versions of CircuitPython.
</p>
</div>
</div>
</section>
<section>
<h2>Contributing</h2>
<p>
If you'd like to contribute to the CircuitPython project, the CircuitPython
libraries are a great way to begin. Everyone is welcome to contribute!
Regardless of your experience level, we have many resources to get you
started. Check out the Contributing page for detailed information!
</p>
<p>
Find out more about how you can
<a href="{{ "/contributing" | relative_url }}" title="Contributing Page">contribute to CircuitPython libraries</a>.
</p>
<h2>Library Activity for Week of {{ site.data.libraries.updated_at | date: "%a, %b %d, %Y" }}</h2>
<p>
Thank you to all of our contributors!
</p>
<p>
This week there were {{ site.data.libraries.merged_pr_count }} pull requests merged:
<ul>
<li>
Authors:
{% for contributor in site.data.libraries.contributors %}
<a href="https://github.com/{{contributor}}" title="Contributor Name">{{contributor}}</a>{% if forloop.last != true %}, {% endif %}
{% endfor %}
</li>
<li>
Reviewers:
{% for reviewer in site.data.libraries.reviewers %}
<a href="https://github.com/{{reviewer}}" title="Contributor Name">{{reviewer}}</a>{% if forloop.last != true %}, {% endif %}
{% endfor %}
</li>
</ul>
</p>
<div class="libraries new">
<h3>New Libraries</h3>
<ul>
{% for library in site.data.libraries.library_updates.new %}
<li><a href="{{library[1]}}" title="New Library Location">{{library[0]}}</a></li>
{% endfor %}
</ul>
</div>
<div class="libraries updated">
<h3>Updated Libraries</h3>
<ul>
{% for library in site.data.libraries.library_updates.updated %}
<li><a href="{{library[1]}}" title="Updated Library Location">{{library[0]}}</a></li>
{% endfor %}
</ul>
</div>
</section>
</div>
<script src="/assets/javascript/libraries.js"></script>