diff --git a/.gitignore b/.gitignore index 27be9846..dbf3d28f 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,6 @@ public/ public-deployed/ resources/ themes/solus/static/css/fonts/*.html -themes/solus/static/css/solhub.css \ No newline at end of file +themes/solus/static/css/solhub.css + +.zed/ diff --git a/Makefile b/Makefile index 9216ee44..4db7570f 100755 --- a/Makefile +++ b/Makefile @@ -3,23 +3,9 @@ SHELL = /bin/bash local: hugo server --watch --disableFastRender --ignoreCache -deploy: - hugo --quiet --cleanDestinationDir --destination public-deployed/ - mv public-deployed/podcasts/sundays-with-solus-mp3/index.html public-deployed/podcasts/sundays-with-solus-mp3.xml - mv public-deployed/podcasts/sundays-with-solus-ogg/index.html public-deployed/podcasts/sundays-with-solus-ogg.xml - rmdir public-deployed/podcasts/sundays-with-solus-{mp3,ogg} - rm -r public-deployed/podcasts/{page,index}* - setup: - git submodule init sudo eopkg install hugo sassc -sync: - git submodule sync - git submodule update --force --recursive --remote --rebase - help: - @echo "deploy - Create the deployed form of site. Not particularly useful for those not able to deploy the site." @echo "local - Run the Solus Site locally." @echo "setup - Install necessary tooling for minification." - @echo "sync - Update git submodules and update assets." diff --git a/config.toml b/config.toml index 17d96ac7..5106ef11 100755 --- a/config.toml +++ b/config.toml @@ -13,7 +13,7 @@ defaultContentLanguage = "en" defaultContentLanguageInSubdir = false googleanalytics = "UA-Not-Yet" metaDataFormat = "toml" -paginate = 5 +pagination.pagerSize = 5 theme = ["blog", "solus"] enableInlineShortcodes = true diff --git a/themes/solus/assets/sass/solbit/.gitignore b/themes/solus/.gitignore similarity index 100% rename from themes/solus/assets/sass/solbit/.gitignore rename to themes/solus/.gitignore diff --git a/themes/solus/assets/sass/solbit/Makefile b/themes/solus/Makefile similarity index 100% rename from themes/solus/assets/sass/solbit/Makefile rename to themes/solus/Makefile diff --git a/themes/solus/assets/sass/solbit/sass/elements/button.sass b/themes/solus/assets/sass/elements/button.sass similarity index 100% rename from themes/solus/assets/sass/solbit/sass/elements/button.sass rename to themes/solus/assets/sass/elements/button.sass diff --git a/themes/solus/assets/sass/solbit/sass/elements/code.sass b/themes/solus/assets/sass/elements/code.sass similarity index 100% rename from themes/solus/assets/sass/solbit/sass/elements/code.sass rename to themes/solus/assets/sass/elements/code.sass diff --git a/themes/solus/assets/sass/solbit/sass/elements/headings.sass b/themes/solus/assets/sass/elements/headings.sass similarity index 100% rename from themes/solus/assets/sass/solbit/sass/elements/headings.sass rename to themes/solus/assets/sass/elements/headings.sass diff --git a/themes/solus/assets/sass/solbit/sass/elements/keyboard.sass b/themes/solus/assets/sass/elements/keyboard.sass similarity index 100% rename from themes/solus/assets/sass/solbit/sass/elements/keyboard.sass rename to themes/solus/assets/sass/elements/keyboard.sass diff --git a/themes/solus/assets/sass/solbit/sass/elements/list.sass b/themes/solus/assets/sass/elements/list.sass similarity index 100% rename from themes/solus/assets/sass/solbit/sass/elements/list.sass rename to themes/solus/assets/sass/elements/list.sass diff --git a/themes/solus/assets/sass/elements/menu.sass b/themes/solus/assets/sass/elements/menu.sass index 154b0856..57d49831 100644 --- a/themes/solus/assets/sass/elements/menu.sass +++ b/themes/solus/assets/sass/elements/menu.sass @@ -1,6 +1,22 @@ // Menu .menu + @include row() + @include fullWidth() + + b + @include box($menu-label-box) + + nav + @include row() + gap: $menu-link-gap + flex-wrap: wrap + @include fullWidth() + + a + display: flex + align-items: center + &.column @include column() @include box($menu-column-box) diff --git a/themes/solus/assets/sass/solbit/sass/elements/paginate.sass b/themes/solus/assets/sass/elements/paginate.sass similarity index 100% rename from themes/solus/assets/sass/solbit/sass/elements/paginate.sass rename to themes/solus/assets/sass/elements/paginate.sass diff --git a/themes/solus/assets/sass/solbit/sass/elements/quote.sass b/themes/solus/assets/sass/elements/quote.sass similarity index 100% rename from themes/solus/assets/sass/solbit/sass/elements/quote.sass rename to themes/solus/assets/sass/elements/quote.sass diff --git a/themes/solus/assets/sass/solbit/sass/elements/search.sass b/themes/solus/assets/sass/elements/search.sass similarity index 100% rename from themes/solus/assets/sass/solbit/sass/elements/search.sass rename to themes/solus/assets/sass/elements/search.sass diff --git a/themes/solus/assets/sass/solbit/sass/elements/tables.sass b/themes/solus/assets/sass/elements/tables.sass similarity index 100% rename from themes/solus/assets/sass/solbit/sass/elements/tables.sass rename to themes/solus/assets/sass/elements/tables.sass diff --git a/themes/solus/assets/sass/solbit/sass/elements/video.sass b/themes/solus/assets/sass/elements/video.sass similarity index 100% rename from themes/solus/assets/sass/solbit/sass/elements/video.sass rename to themes/solus/assets/sass/elements/video.sass diff --git a/themes/solus/assets/sass/meta/colors.sass b/themes/solus/assets/sass/meta/colors.sass index 84f391d7..ee07bd85 100644 --- a/themes/solus/assets/sass/meta/colors.sass +++ b/themes/solus/assets/sass/meta/colors.sass @@ -3,6 +3,12 @@ // ------------ // Main Colors +$solus-blue: #5294E2 +$blue: #1a559c +$gray: #333 +$marble: #f5f5f5 +$white: #fff + $black: #26292b $border: #eee $egyptian-blue: #5754c7 @@ -10,13 +16,45 @@ $lime: #37D79A $mauve: #c489bd $yellow: #ffcc00 -// Solbit Overrides +// Pastels +$green: #87d838 $red: #ef2929 +$orange: #ff9900 +$purple: #c489bd + +// Derived Colors +$light-gray: darken($marble, 10%) + +// Defaults +$link: $blue +$text: $gray // -------- // Swatches // -------- +// Get background color +@function bg($swatch) + @return map-get($swatch, bg) + +// Get foreground color +@function fg($swatch) + @return map-get($swatch, fg) + +// Simple mixin for applying a swatch to an element +@mixin colors($swatch) + background: bg($swatch) + color: fg($swatch) + +// Normal Swatches +$swatch-default: (bg: $white, fg: $solus-blue) +$swatch-gray: (bg: $gray, fg: $white) +$swatch-light-gray: (bg: $light-gray, fg: $gray) +$swatch-marble: (bg: $marble, fg: $gray) +$swatch-solus: (bg: $solus-blue, fg: $white) +$swatch-white: (bg: $white, fg: $gray) + + // Desktop Swatches $swatch-budgie: (bg: $solus-blue, fg: $white) $swatch-gnome: (bg: $egyptian-blue, fg: $white) @@ -27,6 +65,27 @@ $swatch-xfce: (bg: $lime, fg: $black) // Elements // -------- +// --- Buttons --- +$button-swatch: $swatch-solus +$button-inverse-swatch: $swatch-default +$button-white-swatch: $swatch-white +$button-menu-inactive-color: $gray +// --- Code ---- +$code-swatch: $swatch-marble +// --- Keyboard --- +$kbd-swatch: $swatch-light-gray +// --- Navigation --- +$navigation-swatch: $swatch-marble +// --- Quotes --- +$quote-swatch: $swatch-light-gray +$quote-border-color: $gray +// --- Search --- +$search-swatch: $swatch-white +// --- Tables --- +$table-header-swatch: $swatch-gray +$table-cell-odd: $white +$table-cell-even: $light-gray + // Menus $menu-column-border: $solus-blue @@ -54,6 +113,23 @@ $panel-podcast-swatch: $swatch-marble $tag-swatch: $swatch-solus +// ------ +// Structure +// ------ + +// --- HTML --- +$body-swatch: $swatch-default +// --- Banner --- +$banner-top-swatch: $swatch-solus +// --- Footer --- +$footer-swatch: $navigation-swatch +// --- Header --- +$header-swatch: $navigation-swatch +$header-menu-swatch: $swatch-light-gray +// --- Table of Contents --- +$toc-swatch: (bg: $marble, fg: $link) + + // -------- // Pages // -------- diff --git a/themes/solus/assets/sass/solbit/sass/meta/fonts.sass b/themes/solus/assets/sass/meta/fonts.sass similarity index 100% rename from themes/solus/assets/sass/solbit/sass/meta/fonts.sass rename to themes/solus/assets/sass/meta/fonts.sass diff --git a/themes/solus/assets/sass/solbit/sass/meta/mixins.sass b/themes/solus/assets/sass/meta/mixins.sass similarity index 100% rename from themes/solus/assets/sass/solbit/sass/meta/mixins.sass rename to themes/solus/assets/sass/meta/mixins.sass diff --git a/themes/solus/assets/sass/solbit/sass/meta/resets.sass b/themes/solus/assets/sass/meta/resets.sass similarity index 100% rename from themes/solus/assets/sass/solbit/sass/meta/resets.sass rename to themes/solus/assets/sass/meta/resets.sass diff --git a/themes/solus/assets/sass/meta/sizes.sass b/themes/solus/assets/sass/meta/sizes.sass index f605ff87..237a468f 100644 --- a/themes/solus/assets/sass/meta/sizes.sass +++ b/themes/solus/assets/sass/meta/sizes.sass @@ -1,13 +1,100 @@ // Sizes + +// -------- +// Defaults +// -------- + +// Media Sizes +$desktop: (min-width: 1024px) +$mobile: (max-width: 1023px) +$mac: (max-width: 1439px) + +// Text Sizes +$size-h1: 2.5em +$size-h2: 2em +$size-h3: 1.75em +$size-h4: 1.5em +$size-h5: 1.25em +$size-text: 1em + +// Gap Sizes +$gap-max: 2.5em +$gap-big: 2em +$gap-large: 1.5em +$gap-medium: 1.25em +$gap-normal: 1em +$gap-small: 0.625em +$gap-min: 0.5em + +// Common Sizes +$content-margin: 1rem +$page-margin: 10% +$page-margin-mobile: 5% +$paragraph-box: (margin-bottom: $gap-medium) +$reset-box: (box-sizing: border-box, line-height: 1.25em, margin: 0, padding: 0) + +// ------ +// Mixins +// ------ + +@mixin box($box) + @each $attr, $value in $box + #{$attr}: $value + + // -------- // Elements // -------- +// Banner +$banner-box: (padding: $gap-medium $page-margin) +$banner-box-mobile: (padding: $gap-medium $page-margin-mobile) +$banner-heading-box: (margin: 0 0 $gap-normal) +$banner-top-h1-size: $size-h4 +$banner-top-h2-size: $size-text + +// Buttons +$button-box: (height: 2.5em, line-height: 2.5em, padding: 0 $gap-big) +$button-small-box: (height: 2em, line-height: 2em) + +// Code +$code-border-radius: 0.25em +$code-box: (padding: 0.1em) +$pre-box: (padding: $gap-normal, margin: 0 0 $content-margin) + +// Content +$content-img-box: (max-width: 100%, margin: 0 0 $content-margin) +$content-img-featured-box: (margin: 0 0 $gap-big) +$paragraph-box: (min-height: 1.5em, line-height: 1.5em, margin: 0 0 $content-margin) +$heading-box: (margin: $content-margin 0) +$heading-top-box: (margin: $content-margin) + +// Footer +$footer-legal-box: (margin: $gap-normal 0) +$footer-gap: $gap-min +$footer-box: (padding: $gap-max $page-margin) +$footer-box-mobile: (padding: $gap-max $page-margin-mobile) + +// Keyboard +$kbd-border-radius: 0.125em +$kbd-box: (line-height: 2em, margin: 0 0.25em, padding: 0 $gap-min) + +// Lists +$list-box: (line-height: 2em, padding: 0 $gap-big) +$list-item-box: (margin: $gap-min 0 0) +$list-box-all: (margin: 0 0 $gap-normal) + // Menus $menu-column-box: (margin-bottom: $gap-big, padding: 0 $gap-normal $gap-normal) $menu-column-title-box: (margin-bottom: 0.5em) $menu-column-title-font-size: $size-h4 +$menu-label-box: (width: 9.375em) +$menu-link-gap: $gap-normal $gap-big + +// Pagination +$pages-box: (padding: $gap-normal) +$pages-button-box: (padding: 0 $gap-big) // Panels $panel-gap: $gap-big @@ -40,15 +127,60 @@ $showcase-img-box: (height: fit-content, width: 4em) $showcase-section-box: (width: 24em) $showcase-section-gap: $gap-normal +// Quotes +$quote-box: (margin: 0 $gap-big $content-margin, padding: $gap-normal $gap-big) +$quote-border-width: 0.125em + +// Search +$search-box: (width: 30em, line-height: 3em, padding: $gap-min) +$search-before-box: (padding: 0 $gap-min) + // Tags $tag-box: (height: 1.25em, line-height: 1.25em, padding: 0 $gap-min) $tag-font-size: $size-text $tag-radius: 0.625em -// Video Player +// Tables +$table-box: (width: initial, margin: 0 0 $content-margin) +$table-cell-box: (padding: 0 $gap-normal) +$table-head-box: (height: 3em) +$table-row-box: (height: 2em) +$table-border-width: 0.125em + +// Video +$video-box: (margin: 0 0 $content-margin) $video-player-box: (height: 33em) +// --------- +// Structure +// --------- + + +// Header +$header-bar-box: (height: 5em, padding: $gap-small $page-margin) +$header-bar-box-mobile: (height: 3.75em, padding: $gap-small $page-margin-mobile) +$header-bar-logo-box: (min-width: 0) +$header-button-box: (padding: 0 $gap-min) +$header-button-font-size: $size-h4 +$header-link-box: (line-height: 2em) +$header-overlay-box: (padding: $gap-small $page-margin-mobile) +$header-overlay-font-size: $size-h2 +$header-overlay-gap: $gap-min + +// Main +$main-box: (min-height: 100%, padding: $gap-medium $page-margin) +$main-box-mobile: (padding: $gap-medium $page-margin-mobile) +$main-gap: $gap-big + +// Table of Contents +$toc-box: (margin: 4em 0 0) +$toc-nav-box: (width: initial, margin: $gap-min 0 0, padding: $gap-normal) +$toc-heading-font-size: $size-h5 +$toc-nav-font-size: $size-text +$toc-nav-indent: $gap-normal + + // ----- // Pages // ----- diff --git a/themes/solus/assets/sass/solbit/LICENSE.md b/themes/solus/assets/sass/solbit/LICENSE.md deleted file mode 100755 index 8f71f43f..00000000 --- a/themes/solus/assets/sass/solbit/LICENSE.md +++ /dev/null @@ -1,202 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright {yyyy} {name of copyright owner} - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - diff --git a/themes/solus/assets/sass/solbit/README.md b/themes/solus/assets/sass/solbit/README.md deleted file mode 100644 index ba460b72..00000000 --- a/themes/solus/assets/sass/solbit/README.md +++ /dev/null @@ -1,37 +0,0 @@ -# Solbit - -Solbit is the unified component styling for Solus brand assets, such as Help Center and Solus websites, as well as future Solhub. - -## Font - -The Solbit Icons font is intended to work independently of any separate fonts provided via brand assets, such as from the Solus websites / platforms. - - -## Styling - -The Solbit Styling is intended to be utilized by the respective styling of the above listed assets and **is not intended to be shipped independently**. Compilation of -solbit is purely **intended to validate** a lack of SASS errors. Assets inheriting this theming due so via Git submodules and leverage SASS importing to merge it into a single stylesheet. - -## Development - -### Dependencies - -To get started on development, run `make setup` on Solus. - -### Styling - -Solbit styling takes advantage of SASS for a wide variety of features, such as mixins, variables, and nesting. - -### Compile - -- All the things: `make` -- Fonts: `make font` -- SASS: `make sass` - -### Styling - -I use 4-char wide tabs, not spaces, in everything **except** YAML files, as enforced by YAML's specification. - -## Licensing - -All source **except** for the Solbit font are licensed under Apache-2.0. Solbit font icons are provided by FontAwesome under [SIL OFL 1.1](http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL). diff --git a/themes/solus/assets/sass/solbit/docs/elements.md b/themes/solus/assets/sass/solbit/docs/elements.md deleted file mode 100644 index 87d92d06..00000000 --- a/themes/solus/assets/sass/solbit/docs/elements.md +++ /dev/null @@ -1,126 +0,0 @@ -# Elements - -Solbit defines several reusable elements that may be used freely across a site. - -## Buttons - -Buttons are interactive elements of a solbit page. They do not require JS, but may be used for JS elements. Buttons may use either the `a` or `button` tag. - -``` html -Normal - -Hover -``` - -There are multiple classes of button: - -1. **Normal** - This button is the same size as normal text and take up the full line height. -2. **Small** - This button is a bit smaller that a Normal button and has smaller text as well. -3. **Hover** - Hover buttons have a slight radius and change color when a visitor hovers their cursor over them. - -> **NOTE:** Hover may be combined with normal or small buttons. - -### Custom Button Types - -Solbit users may also leverage the `proto-button` mixin to create custom button elements. - - -## Code - -Sometimes it is useful to render code on your site. You may also choose to rely on something like `highlight.js` to highlight syntax. Solbit supports bare code tags, but may require a `pre` wrapper element if the contained code is HTML. - -``` -
-     ... 
-
- ... -``` - - -## Headings - -Solbit headings act just like normal headings. However, the sizes have been chosen for readability and consistency. - - -## Keyboard Bindings - -Solbit stylizes `kbd` tags for better legibility. They are otherwise identical in use as they would be for bare HTML. - - -## Lists - -Solbit applies consistent styling to lists. Nothing fancy, but definitely readable. - - -## Menus - -A custom menu element is used in several places by solbit. In general, it is a list of navigation links, but an optional label may be specified. - -``` html -
- Optional Label - -
-``` - - -## Pagination - -Sometimes it is useful to allow pagination for lists of related pages. Solbit tries to make this as easy as possible by using a list of page links and marking the current page with the `button` class. - -``` html - -``` - -## Quotes - -Every once in awhile it is useful to have a blockquote style. Solbit keeps this one really simple: - -``` html -
- Hello World -
-``` - -## Search - -Our search is optional here so that clients without JS won't display a broken search element. - -``` html - -``` - -1. **Label** - We can label the search button with an icon and text -2. **Shortcut** - For site-generators like `mkdocs` we might also support a keyboard shortcut to open the search. In this case it is ```ctrl``` + ```k``` - - -## Tables - -Solbit doesn't do anything particularly special with tables. It simply provides default styling and tries to help them display better on different devices. - - -## Video - -In Solbit, a video is rendered using the client style-sheet for symplicity, but the width of the video pane is limited by CSS rules. - diff --git a/themes/solus/assets/sass/solbit/docs/meta.md b/themes/solus/assets/sass/solbit/docs/meta.md deleted file mode 100644 index 90781056..00000000 --- a/themes/solus/assets/sass/solbit/docs/meta.md +++ /dev/null @@ -1,16 +0,0 @@ -# Meta - -For better maintainability, several sets of SASS definitions are broken out into their own file. This has the added benefit of making it much easier to override the defaults. - -1. **Colors** - Every single color used in Solbit must only be referenced as a variable. This file contains all of those color declorations. -2. **Sizes** - Like colors, sizes are only referenced by name. All of the declarations are defined in this file. -3. **Functions** - SASS functions allow a developer to reuse code as neccessary. All Solbit functions are defined here. -4. **Mixins** - SASS mixins make it possible to easily define multiple CSS rules and to set their values using parameters. The Solbit mixins are used heavily to llow developers to change them in one location and still have that change reflected across the whole codebase. -5. **Fonts** - The primary font-face for a Solbit site is defined here. -6. **Resets** - Because each browser ships with its own user-stylesheet, resets are used to override the most prolematic default settings to allow for consist display accross browsers. diff --git a/themes/solus/assets/sass/solbit/docs/structure.md b/themes/solus/assets/sass/solbit/docs/structure.md deleted file mode 100644 index 2b0bf10a..00000000 --- a/themes/solus/assets/sass/solbit/docs/structure.md +++ /dev/null @@ -1,68 +0,0 @@ -# Solbit Structure - -## HTML Layout - -Our goal here is to use the semantically appropriate HTML tags wherever possible, and this starts from the very beginning. The `html`, `head`, and `body` tags are pretty wrong to mess with, so they are unchanged. - -``` html - - ... - - ... - - -``` - -### Head Contents - -There are tons of different information we might decide to encode inside `head`, so lets focus on what Solbit really needs to work right: - -``` html - - - - - - -``` - -1. **Viewport** - In order to make sure our styles scale correctly on all screen sizes, we enforce the default viewport scaling. -2. **CSS** - This one is no surprise, we need to include the stylesheet. What *is* a surprise, is that Solbit uses **ZERO** JavaScript. -3. **Roboto** - Solus uses Roboto as the font on all of our sites. Solbit is no different. -4. **Noscript** - Sure, most people have JS enabled all the time. Maybe they have an ad-blocker that disabled JS from some sources. But we still want our sites to be useful for browser clients with lower capabilities. A site should work without JS and be more powerful with JS. Adding this `noscript` entry makes it easy to hide those JS elements for clients that can't use them. - -## Body Layout - -Solbit keeps a consistent page layout for all content: - -``` html - -
...
- - - - -
...
- - - -``` - -1. **(Header)[structure/header.md]** - Each page starts with a common header which provides a site logo and basic navigation. -2. **(Banner)[structure/banner.md]** - Sometimes we want to labe a particular section of our site. This is especially useful when the site is made from multiple Github Pages repositories. And to make search functionality easier, we'll focus on searching in just that section instead of a global search for the site. -3. **(Main)[structure/main.md]** - Many sites get this one wrong and it hurts SEO. Solbit makes sure that you have a `main` that declares where the important page content resides. -4. **(Footer)[structure/footer.md]** - As with most sites, a Solbit footer is predominantly focused on providing more detailed navigation and any copyright or legal notices. diff --git a/themes/solus/assets/sass/solbit/docs/structure/banner.md b/themes/solus/assets/sass/solbit/docs/structure/banner.md deleted file mode 100644 index 227f1e32..00000000 --- a/themes/solus/assets/sass/solbit/docs/structure/banner.md +++ /dev/null @@ -1,18 +0,0 @@ -# Banner & Search - -When it makes sense to, our sites should be broken up into more maintainable pieces. Solbit encourages the use of a Banner to denote these larger sections: - -``` html - -``` - -1. **Section Name** - The name of this portion of the site -2. **Section Description** - A short description of what's in this section -3. **(Optional Search Button)[../elements.md]** - This button may be used to activate a search modal. \ No newline at end of file diff --git a/themes/solus/assets/sass/solbit/docs/structure/footer.md b/themes/solus/assets/sass/solbit/docs/structure/footer.md deleted file mode 100644 index 2aa52fb9..00000000 --- a/themes/solus/assets/sass/solbit/docs/structure/footer.md +++ /dev/null @@ -1,21 +0,0 @@ -# Footer - -The `footer` is the very last element on a page. It provides more detailed navigation for visitors, as well as any copyright notices. - -``` html -