Squash previous changes and rebase master branch

Set theme jekyll-theme-slate update _config.yml move some files around add an index file delete files that will no longer be needed include jekyll front matter Update the index page layout to use updated template re-create the page layout from the updated template add a favicon remove manual gh pages build script use master branch docs/ folder instead add favicon to default layout move layouts and includes back because of restriction with gh pages testing: move index back into project root move everything under docs, including config.yml dont put the favicon in _includes Fix building locally, fix logo - resize the original logo document so that it doesn't have extra whitespace - style the logo to match the original page - fix issue when building locally, repo format was incorrect Ignore files that are specific to documentation add a readme that describes how to build the docs remove downloads, since installation instructions are provided elsewhere fix broken links in index page fix the page header on all non-index pages use site.baseurl for images fix urls when on testing site with baseurl
pwr-Solaar · Jul 27, 2019 · f88951c · f88951c
1 parent 2aab7f7
commit f88951c
Show file tree

Hide file tree

Showing 18 changed files with 357 additions and 776 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,6 @@
+# ignore documentation-specific files
+
+.jekyll-metadata
+Gemfile
+Gemfile.lock
+_site/
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,4 @@
+# Documentation Readme
+
+This project's documentation is hosted using GitHub pages, which serves static pages using Jeykll.
+[Please refer to the official documentation for instructions for how to build the site locally.](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/)
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,11 @@
+title: Solaar
+description: Linux Device manager for the Logitech Unifying Receiver.
+tagline: Linux Device manager for the Logitech Unifying Receiver.
+owner: pwr
+owner_url: https://github.com/pwr
+repository: pwr/Solaar
+version: 0.9.2
+ga_id: UA-36908718-1
+show_downloads: false
+encoding: utf-8
+theme: jekyll-theme-slate
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -0,0 +1,64 @@
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: "en-US" }}">
+
+  <head>
+    <meta charset='utf-8'>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width,maximum-scale=2">
+	<link rel="stylesheet" type="text/css" media="screen" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
+	<link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/favicon.png" />
+
+{% seo %}
+  </head>
+
+  <body>
+
+    <!-- HEADER -->
+    <div id="header_wrap" class="outer">
+        <header class="inner">
+          {% if site.github.is_project_page %}
+            <a id="forkme_banner" href="{{ site.github.repository_url }}">View on GitHub</a>
+          {% endif %}
+          <h1 id="project_title">
+            <img src="{{ site.baseurl }}/assets/solaar.svg" style="margin-bottom: -10px; width: 48px; height: 48px; border: 0; box-shadow: none;" />
+            {{ site.title | default: site.github.repository_name }}</h1>
+          <h2 id="project_tagline">{{ site.description | default: site.github.project_tagline }}</h2>
+
+          {% if site.show_downloads %}
+            <section id="downloads">
+              <a class="zip_download_link" href="{{ site.github.zip_url }}">Download this project as a .zip file</a>
+              <a class="tar_download_link" href="{{ site.github.tar_url }}">Download this project as a tar.gz file</a>
+            </section>
+          {% endif %}
+        </header>
+    </div>
+
+    <!-- MAIN CONTENT -->
+    <div id="main_content_wrap" class="outer">
+      <section id="main_content" class="inner">
+        {{ content }}
+      </section>
+    </div>
+
+    <!-- FOOTER  -->
+    <div id="footer_wrap" class="outer">
+      <footer class="inner">
+        {% if site.github.is_project_page %}
+        <p class="copyright">{{ site.title | default: site.github.repository_name }} maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a></p>
+        {% endif %}
+        <p>Published with <a href="https://pages.github.com">GitHub Pages</a></p>
+      </footer>
+    </div>
+
+    {% if site.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', '{{ site.google_analytics }}', 'auto');
+        ga('send', 'pageview');
+      </script>
+    {% endif %}
+  </body>
+</html>
diff --git a/docs/_layouts/page.html b/docs/_layouts/page.html
@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: "en-US" }}">
+
+  <head>
+    <meta charset='utf-8'>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width,maximum-scale=2">
+    <link rel="stylesheet" type="text/css" media="screen" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
+    <link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/favicon.png" />
+{% seo %}
+  </head>
+
+  <body>
+
+    <!-- HEADER -->
+    <div id="header_wrap" class="outer">
+        <header class="inner">
+          {% if site.github.is_project_page %}
+            <a id="forkme_banner" href="{{ site.github.repository_url }}">View on GitHub</a>
+          {% endif %}
+
+          <h1 id="project_title">
+              <a href="{{ site.baseurl }}" style="color: #fff;">
+                <img src="{{ site.baseurl }}/assets/solaar.svg" style="margin-bottom: -10px; width: 48px; height: 48px; border: 0; box-shadow: none;" />
+                {{ site.title | default: site.github.repository_name }}</h1>
+              </a>
+        </header>
+    </div>
+
+    <!-- MAIN CONTENT -->
+    <div id="main_content_wrap" class="outer">
+      <section id="main_content" class="inner">
+        {{ content }}
+      </section>
+    </div>
+
+    <!-- FOOTER  -->
+    <div id="footer_wrap" class="outer">
+      <footer class="inner">
+        {% if site.github.is_project_page %}
+        <p class="copyright">{{ site.title | default: site.github.repository_name }} maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a></p>
+        {% endif %}
+        <p>Published with <a href="https://pages.github.com">GitHub Pages</a></p>
+      </footer>
+    </div>
+
+    {% if site.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', '{{ site.google_analytics }}', 'auto');
+        ga('send', 'pageview');
+      </script>
+    {% endif %}
+  </body>
+</html>
diff --git a/docs/assets/favicon.png b/docs/assets/favicon.png
diff --git a/docs/assets/solaar.svg b/docs/assets/solaar.svg
diff --git a/docs/debian.md b/docs/debian.md
@@ -1,3 +1,8 @@
+---
+title: Debian Repository
+layout: page
+---
+
 # Debian repository
 
 Solaar is now part of the [official debian repository](https://packages.debian.org/solaar-gnome3), to install it on your debian machine, use the following command: `sudo apt install solaar-gnome3`
diff --git a/docs/devices.md b/docs/devices.md
@@ -1,3 +1,8 @@
+---
+title: Supported Devices
+layout: page
+---
+
 # Supported devices
 
 **Solaar** will detect all devices paired with your receiver, and at the very

diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,99 @@
+---
+title: Solaar
+layout: default
+---
+
+**Solaar** is a Linux device manager for Logitech's [Unifying][unifying] Receiver
+peripherals. It is able to pair/unpair devices to the receiver, and for most
+devices read battery status.
+
+It comes in two flavors, command-line and GUI.  Both are able to list the
+devices paired to a Unifying Receiver, show detailed info for each device, and
+also pair/unpair supported devices with the receiver.
+
+[unifying]: http://logitech.com/promotions/6072
+
+## Supported Devices
+
+**Solaar** will detect all devices paired with your Unifying Receiver, and at
+the very least display some basic information about them.
+
+For some devices, extra settings (usually not available through the standard
+Linux system configuration) are supported. For a full list of supported devices
+and their features, see [docs/devices.md]({{ site.baseurl }}/devices).
+
+
+## Pre-built packages
+
+Pre-built packages are available for a few Linux distros.
+
+* Debian 7 (Wheezy) or higher: packages in this [repository]({{ site.baseurl }}/debian)
+* Ubuntu/Kubuntu 16.04+: use the `solaar-gnome3` and/or `solaar` package from [universe repository][universe repository]
+* Ubuntu/Kubuntu 12.04 to 14.04: use `solaar` package from [ppa:daniel.pavel/solaar][ppa]
+
+The `solaar` package uses a standard system tray implementation; to ensure
+integration with *gnome-shell* or *Unity*, install `solaar-gnome3`.
+
+* an [Arch package][arch], courtesy of Arnaud Taffanel
+* a [Fedora package][fedora], courtesy of Eric Smith
+* a [Gentoo package][gentoo], courtesy of Carlos Silva and Tim Harder
+* a [Mageia package][mageia], courtesy of David Geiger
+* an [OpenSUSE rpm][opensuse], courtesy of Mathias Homann
+
+[ppa]: http://launchpad.net/~daniel.pavel/+archive/solaar
+[arch]: http://aur.archlinux.org/packages/solaar
+[fedora]: https://apps.fedoraproject.org/packages/solaar
+[gentoo]: https://packages.gentoo.org/packages/app-misc/solaar
+[mageia]: http://mageia.madb.org/package/show/release/cauldron/application/0/name/solaar
+[opensuse]: http://software.opensuse.org/package/Solaar
+[universe repository]: http://packages.ubuntu.com/search?keywords=solaar&searchon=names&suite=all&section=all
+
+
+## Manual installation
+
+See [docs/installation.md]({{ site.baseurl }}/installation) for the step-by-step
+procedure for manual installation.
+
+
+## Known Issues
+
+- KDE/Kubuntu: if some icons appear broken in the application, make sure you've
+  properly configured the Gtk theme and icon theme in KDE's control panel.
+
+- Some devices using the [Nano Receiver][nano] (which is very similar to the
+  Unifying Receiver) are supported, but not all. For details, see
+  [docs/devices.md]({{ site.baseurl }}/devices).
+
+- Running the command-line application (`bin/solaar-cli`) while the GUI
+  application is also running *may* occasionally cause either of them to become
+  confused about the state of the devices. I haven't encountered this often
+  enough to be able to be able to diagnose it properly yet.
+
+[nano]: http://support.logitech.com/en_us/parts
+
+
+## License
+
+This software is distributed under the terms of the
+[GNU Public License, v2](COPYING).
+
+
+## Thanks
+
+This project began as a third-hand clone of [Noah K. Tilton](https://github.com/noah)'s
+logitech-solar-k750 project on GitHub (no longer available). It was developed
+further thanks to the diggings in Logitech's HID++ protocol done by many other
+people:
+
+- [Julien Danjou](http://julien.danjou.info/blog/2012/logitech-k750-linux-support),
+who also provided some internal
+[Logitech documentation](http://julien.danjou.info/blog/2012/logitech-unifying-upower)
+- [Lars-Dominik Braun](http://6xq.net/git/lars/lshidpp.git)
+- [Alexander Hofbauer](http://derhofbauer.at/blog/blog/2012/08/28/logitech-performance-mx)
+- [Clach04](http://bitbucket.org/clach04/logitech-unifying-receiver-tools)
+- [Peter Wu](https://lekensteyn.nl/logitech-unifying.html)
+- [Nestor Lopez Casado](http://drive.google.com/folderview?id=0BxbRzx7vEV7eWmgwazJ3NUFfQ28)
+provided some more Logitech specifications for the HID++ protocol
+
+Also thanks to Douglas Wagner, Julien Gascard and Peter Wu for helping with
+application testing and supporting new devices.
diff --git a/docs/installation.md b/docs/installation.md
@@ -1,3 +1,8 @@
+---
+title: Manual Installation
+layout: page
+---
+
 # Manual installation
 
 ### Requirements

diff --git a/jekyll/_config.yml b/jekyll/_config.yml