diff --git a/_layouts/common.html b/_layouts/common.html new file mode 100644 index 00000000..407f3d0a --- /dev/null +++ b/_layouts/common.html @@ -0,0 +1,9 @@ +--- +layout: default +--- + +
+
+ {{ content }} +
+
diff --git a/_layouts/contributing.html b/_layouts/contributing.html index 3801eeb2..616ccbff 100644 --- a/_layouts/contributing.html +++ b/_layouts/contributing.html @@ -1,59 +1,57 @@ --- -layout: default +layout: common --- -
-
-

Contributing

-

- 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. -

-

- 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 - Weblate. -

-

- If this is your first time contributing, or you'd - like to see our recommended contribution workflow, we have a guide on - Contributing to CircuitPython with Git and Github. - You can also find us in the #circuitpython channel on the - Adafruit Discord. -

-

- Have an idea for a new driver or library? - File an issue on the CircuitPython repo! -

-

Current Status for {{ site.data.libraries.updated_at | date: "%a, %b %d, %Y" }}

+
+

Contributing

+

+ 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. +

+

+ 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 + Weblate. +

+

+ If this is your first time contributing, or you'd + like to see our recommended contribution workflow, we have a guide on + Contributing to CircuitPython with Git and Github. + You can also find us in the #circuitpython channel on the + Adafruit Discord. +

+

+ Have an idea for a new driver or library? + File an issue on the CircuitPython repo! +

+

Current Status for {{ site.data.libraries.updated_at | date: "%a, %b %d, %Y" }}

- {% assign current = page.url | downcase | split: '/' %} - -
- {{ content }} -
+ {% assign current = page.url | downcase | split: '/' %} + +
+ {{ content }}
diff --git a/assets/sass/pages/_libraries.scss b/assets/sass/pages/_libraries.scss index c1eb1bf7..0c04cd3f 100644 --- a/assets/sass/pages/_libraries.scss +++ b/assets/sass/pages/_libraries.scss @@ -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; } } } diff --git a/awesome.html b/awesome.html index e1f3c0aa..f4ab1a04 100644 --- a/awesome.html +++ b/awesome.html @@ -1,12 +1,10 @@ --- -layout: home +layout: common title: Awesome permalink: /awesome --- -
-
- {% capture awesome_include %}{% include_relative awesome-circuitpython/README.md %}{% endcapture %} - {{ awesome_include | markdownify }} -
+
+ {% capture awesome_include %}{% include_relative awesome-circuitpython/README.md %}{% endcapture %} + {{ awesome_include | markdownify }}
diff --git a/connect/index.md b/connect/index.md index f6980963..d883ba5f 100644 --- a/connect/index.md +++ b/connect/index.md @@ -1,5 +1,5 @@ --- -layout: default +layout: common --- # Overview diff --git a/libraries/contributing/index.html b/libraries/contributing/index.html index 12e36b88..b6ca1318 100644 --- a/libraries/contributing/index.html +++ b/libraries/contributing/index.html @@ -1,13 +1,11 @@ --- -layout: default +layout: common title: Libraries permalink: /libraries/contributing redirect_to: /contributing --- -
-
-

This page has moved to the dedicated contributing - page. -

-
+
+

This page has moved to the dedicated contributing + page. +

diff --git a/libraries/index.html b/libraries/index.html index d8851c7a..0c5ed998 100644 --- a/libraries/index.html +++ b/libraries/index.html @@ -1,185 +1,183 @@ --- -layout: default +layout: common title: Libraries permalink: /libraries --- -
-
-

CircuitPython Libraries

+
+

CircuitPython Libraries

+

+ 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. +

+ 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 CIRCUITPY drive in a folder called lib. + For more information on using and managing libraries, see the + Welcome To CircuitPython Guide. +

+
+

Documentation

- 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 + libraries documentation page + contains a categorized list of all the CircuitPython libraries included in the following bundles, + with links to the documentation for every library. +

Download and Installation Instructions

- 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 CIRCUITPY drive in a folder called lib. - For more information on using and managing libraries, see the - Welcome To CircuitPython Guide. + 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.

-
-

Documentation

-

- The - libraries documentation page - contains a categorized list of all the CircuitPython libraries included in the following bundles, - with links to the documentation for every library. -

Download and Installation Instructions

-

- 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. -

-

- The libraries in each release are supplied as .mpy files, which are compiled - versions of Python source code. - Make sure to download the bundle that matches the major version - of your CircuitPython, because the .mpy files can change between versions. - For example, if you are running 6.3.0 you should download the 6.x bundle. -

-

- The precompiled .mpy files take up less space on your CIRCUITPY drive than the .py files. - They also load faster, and for some low-RAM boards, are required because the .py files - are too large to compile on the board itself. - Unless you need the source version, choose the appropiate .mpy library bundle! - If you need to compile .py files to .mpy, you can - run the mpy-cross - cross-compiler yourself. -

-

- To install, download the appropriate bundle for your version of CircuitPython. - Unzip the file, open the resulting folder and find the lib folder. Open the lib - folder and find the library files you need to load. Create a lib folder on your - CIRCUITPY drive. Copy the individual library files you need to the lib folder - on your CIRCUITPY drive. More details are available - here. -

-

- You can always find the - latest releases of the libraries bundle - on GitHub. -

-

- An alternative way to download and update libraries on your board is to use the - CircUp tool, - which is under development. -

-
-
-

Bundles

-
-
-

Bundle for Version 6.x

-

- This bundle is built for use with CircuitPython 6.x.x. If you are using - CircuitPython 6, please download this bundle. -

-
-
-

Bundle for Version 7.x

-

- 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. -

-
-
-

Python Source Bundle

-

- 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. -

-
-
-

Examples Bundle

-

- 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. -

-
-
-
-
-

The Community Bundle

-

- The libraries in the bundles above are officially supported by Adafruit. - Additional libraries written and supported by community members are available in the - Community Bundle. +

+ The libraries in each release are supplied as .mpy files, which are compiled + versions of Python source code. + Make sure to download the bundle that matches the major version + of your CircuitPython, because the .mpy files can change between versions. + For example, if you are running 6.3.0 you should download the 6.x bundle. +

+

+ The precompiled .mpy files take up less space on your CIRCUITPY drive than the .py files. + They also load faster, and for some low-RAM boards, are required because the .py files + are too large to compile on the board itself. + Unless you need the source version, choose the appropiate .mpy library bundle! + If you need to compile .py files to .mpy, you can + run the mpy-cross + cross-compiler yourself. +

+

+ To install, download the appropriate bundle for your version of CircuitPython. + Unzip the file, open the resulting folder and find the lib folder. Open the lib + folder and find the library files you need to load. Create a lib folder on your + CIRCUITPY drive. Copy the individual library files you need to the lib folder + on your CIRCUITPY drive. More details are available + here. +

+

+ You can always find the + latest releases of the libraries bundle + on GitHub. +

+

+ An alternative way to download and update libraries on your board is to use the + CircUp tool, + which is under development. +

+
+
+

Bundles

+
+
+

Bundle for Version 6.x

+

+ This bundle is built for use with CircuitPython 6.x.x. If you are using + CircuitPython 6, please download this bundle.

-

If you are looking for the 6.x Community Bundle, you can find it on - GitHub. -

-
-
+
+

Bundle for Version 7.x

- 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.

-
-
-

Python Source Bundle

-

- 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. -

-
-
-
-

Contributing

-

- 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! -

-

- Find out more about how you can - contribute to CircuitPython libraries. -

-

Library Activity for Week of {{ site.data.libraries.updated_at | date: "%a, %b %d, %Y" }}

-

- Thank you to all of our contributors! -

-

- This week there were {{ site.data.libraries.merged_pr_count }} pull requests merged: -

    -
  • - Authors: - {% for contributor in site.data.libraries.contributors %} - {{contributor}}{% if forloop.last != true %}, {% endif %} - {% endfor %} -
    • -
  • - Reviewers: - {% for reviewer in site.data.libraries.reviewers %} - {{reviewer}}{% if forloop.last != true %}, {% endif %} - {% endfor %} -
    • -
-

-
-

New Libraries

-
    - {% for library in site.data.libraries.library_updates.new %} -
  • {{library[0]}}
    • - {% endfor %} -
+
+

Python Source Bundle

+

+ 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. +

-
-

Updated Libraries

-
    - {% for library in site.data.libraries.library_updates.updated %} -
  • {{library[0]}}
    • - {% endfor %} -
+
+

Examples Bundle

+

+ 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. +

-
-
+
+ +
+

The Community Bundle

+

+ The libraries in the bundles above are officially supported by Adafruit. + Additional libraries written and supported by community members are available in the + Community Bundle. +

+

If you are looking for the 6.x Community Bundle, you can find it on + GitHub. +

+
+
+

Bundle for Version 7.x

+

+ This bundle is built for use with CircuitPython 7.x.x. If you are using + CircuitPython 7, please download this bundle. +

+
+
+

Python Source Bundle

+

+ 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. +

+
+
+
+
+

Contributing

+

+ 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! +

+

+ Find out more about how you can + contribute to CircuitPython libraries. +

+

Library Activity for Week of {{ site.data.libraries.updated_at | date: "%a, %b %d, %Y" }}

+

+ Thank you to all of our contributors! +

+

+ This week there were {{ site.data.libraries.merged_pr_count }} pull requests merged: +

    +
  • + Authors: + {% for contributor in site.data.libraries.contributors %} + {{contributor}}{% if forloop.last != true %}, {% endif %} + {% endfor %} +
    • +
  • + Reviewers: + {% for reviewer in site.data.libraries.reviewers %} + {{reviewer}}{% if forloop.last != true %}, {% endif %} + {% endfor %} +
    • +
+

+
+

New Libraries

+
    + {% for library in site.data.libraries.library_updates.new %} +
  • {{library[0]}}
    • + {% endfor %} +
+
+
+

Updated Libraries

+
    + {% for library in site.data.libraries.library_updates.updated %} +
  • {{library[0]}}
    • + {% endfor %} +
+
+