restyling 2024

.gitignore

@@ -1,3 +1,6 @@
 html
 _site
 Gemfile.lock
+
+.sass-cache
+.jekyll-cache

Gemfile

@@ -1,11 +1,13 @@
 source 'https://rubygems.org'
 
-gem 'jekyll', '~> 3.5.0'
-gem 'asciidoctor', '~> 1.5.0'
+gem 'jekyll'
 gem 'coderay', '~> 1.1.0'
-gem 'rake-jekyll', '~> 1.1.0'
+
+gem 'kramdown-parser-gfm'
 
 group :jekyll_plugins do
   gem "jekyll-asciidoc", '~> 1.0.0'
-  gem 'jekyll-last-modified-at'
 end
+
+gem 'webrick'
+gem 'jekyll_github_sample', git: "https://github.com/bwillis/jekyll-github-sample", ref: 'master'

README.adoc

@@ -29,11 +29,10 @@ An image from the jekyll project is available and documented here: https://githu
 All you need to do -provided you have Docker installed- is to open a terminal
 and move to the folder where you cloned this repo and issue:
 
-    $ export JEKYLL_VERSION=3.5
-    docker run --rm \
+    $ docker run --rm \
         --publish 4000:4000 \
         --volume="$PWD:/srv/jekyll" \
-        -it jekyll/jekyll:$JEKYLL_VERSION \
+        -it jekyll/jekyll \
         jekyll serve
 
 The container just created will install missing dependencies for you and will

_config.yml

@@ -1,19 +1,58 @@
 # jekyll configuration
 
-title: 'Welcome to the LibreMesh project'
-
+title: LibreMesh
+author: LibreMesh
 exclude: [ 'Gemfile', 'Gemfile.lock', 'Rakefile', 'README', 'vendor' ]
-
 prefix: ''
+asciidoc_ext: txt
+
+# Social (First three Required)
+repo: "https://github.com/libremesh/libremesh.github.io" # edit url
+github_user: "libremesh"
+github_repo: "lime-packages"
+main_repo: "https://github.com/libremesh/lime-packages"
+
+matrix: libremesh-dev:matrix.guifi.net
+mailinglist: https://www.autistici.org/mailman/listinfo/libremesh
+
+
+logo: "assets/logo/logo_nano.png"
+
+color: "#333" # primary color for header, buttons
+accentColor: black  # purple, green, etc.
+themeColor: black  # purple, green, blue, orange, purple, grey
+# fixedNav: 'true' # true or false
+
+defaults:
+  - scope:
+      path: "_docs"
+      type: "docs"
+    values:
+      layout: page
+  - scope:
+      path: ""
+      type: "pages"
+    values:
+      layout: "page"
+  - scope:
+      path: "posts"
+      type: "posts"
+    values:
+      layout: "post"
+  - scope:
+      path: "packages"
+      type: "pages"
+    values:
+      layout: "packages"
+
+plugins: 
+  - jekyll_github_sample
 
 asciidoctor:
   attributes:
     - idseparator=_
-    - source-highlighter=coderay
+    - source-highlighter=rouge
     - icons=font
-    - hardbreaks!
-    - toc=auto
-
-asciidoc_ext: txt
 
-# end of configuration
+exclude:
+  - collect_packages.sh

_data/packages.yml

@@ -0,0 +1,96 @@
+packages:
+  - name: altermundi-grafana
+  - name: auto-usb-wwan
+    readme: Readme.md
+  - name: babeld-auto-gw-mode
+    readme: Readme.md
+  - name: bandwidth-test
+  - name: batman-adv-auto-gw-mode
+  - name: bmx6-auto-gw-mode
+  - name: bmx7-auto-gw-bw-mode
+  - name: bmx7-auto-gw-mode
+  - name: bmx7-mdns
+  - name: check-date-http
+    readme: Readme.md
+  - name: check-internet
+    readme: Readme.md
+  - name: cotonete
+    readme: README.md
+    makefile_external_url: https://raw.githubusercontent.com/nicopace/cotonete/master/packages/cotonete/Makefile
+  - name: deferable-reboot
+  - name: eupgrade
+  - name: first-boot-wizard
+  - name: hotplug-initd-services
+  - name: lime-app
+  - name: lime-ap-watchping
+    readme: README
+  - name: lime-debug
+  - name: lime-docs
+  - name: lime-hwd-ground-routing
+  - name: lime-hwd-openwrt-wan
+  - name: lime-hwd-usbradio
+  - name: lime-proto-anygw
+  - name: lime-proto-babeld
+  - name: lime-proto-batadv
+  - name: lime-proto-bgp
+  - name: lime-proto-bmx6
+  - name: lime-proto-bmx7
+  - name: lime-proto-olsr2
+  - name: lime-proto-olsr6
+  - name: lime-proto-olsr
+  - name: lime-proto-wan
+  - name: lime-report
+  - name: lime-smart-wifi
+  - name: lime-system
+  - name: lime-webui
+  - name: lua-argparse
+    readme: Readme.md
+  - name: luci-app-batman-adv
+  - name: luci-app-openairview
+  - name: luci-lib-jquery-flot
+  - name: luci-mod-status
+  - name: miniserver-client
+  - name: pirania
+    readme: Readme.md
+  - name: prometheus-node-exporter-lua-location-latlon
+  - name: prometheus-node-exporter-lua-wifi-params
+  - name: prometheus-node-exporter-lua-wifi-stations-extra
+  - name: prometheus-node-exporter-lua-wifi-survey
+  - name: prometheus-node-push-influx
+  - name: random-numgen
+  - name: safe-reboot
+  - name: safe-upgrade
+    readme: Readme.md
+  - name: shared-state-async
+    readme: README.adoc
+  - name: shared-state-babeld_hosts
+  - name: shared-state-bat_hosts
+  - name: shared-state-dnsmasq_hosts
+  - name: shared-state-dnsmasq_leases
+  - name: shared-state-dnsmasq_servers
+  - name: shared-state-network_nodes
+  - name: shared-state-node_info
+  - name: shared-state-nodes_and_links
+  - name: shared-state-persist
+  - name: shared-state-pirania
+  - name: shared-state
+  - name: shared-state-wifi_links_info
+  - name: soporteremoto
+  - name: sprunge
+  - name: ubus-lime-batman-adv
+    readme: Readme.md
+  - name: ubus-lime-bmx6
+    readme: Readme.md
+  - name: ubus-lime-groundrouting
+    readme: Readme.md
+  - name: ubus-lime-location
+    readme: Readme.md
+  - name: ubus-lime-metrics
+  - name: ubus-lime-openairview
+    readme: Readme.md
+  - name: ubus-lime-utils
+    readme: README.md
+  - name: ubus-tmate
+    readme: README.md
+  - name: watchping
+  - name: wifi-unstuck-wa

_data/structure.yml

@@ -1,21 +1,37 @@
 main:
   - home
+  - about
   - news
   - communication
   - get_it
   - how_it_works
   - development
-  - docs_overview
-  - about
 
 docs:
-  - docs_overview
-  - quick_starting_guide
-  - connecting_to_nodes
-  - configuration
-  - ethernet_config
-  - wifi_config
-  - hardware
-  - troubleshooting
-
+  - ref: docs_overview
+  - ref: quick_starting_guide
+    subpages:
+      - ref: quick_starting_guide
+      - ref: connecting_to_nodes
+      - ref: cli_configuration
+  - ref: configuration
+    subpages:
+      - ref: configuration
+      - ref: faq-and-recommendations
+      - ref: lime-example
+  - ref: ethernet_config
+  - ref: wifi_config
+  - ref: troubleshooting
+  - ref: hardware
+    subpages:
+      - ref: hardware
+      - ref: tp-link
+      - ref: xiaomi-miwifir3
+
+development:
+  - ref: development
+    subpages:
+    - ref: development
+    - ref: development-network_profiles
+    - ref: development-kernel_vermagic
 

_includes/editable.html

@@ -0,0 +1,59 @@
+<!-- this will parse through the header fields and add a button to open
+     an issue / ask a question on Github. The editable field should be in
+     the post frontend matter, and refer to the label to open the issue for -->
+
+<style>
+.more {
+    float:right;
+    font-size: 1.0rem !important;
+}
+.more:hover {
+    color: cornflowerblue !important;
+}
+
+.dropdown {
+    position: relative;
+    display: inline-block;
+}
+
+.dropdown-content {
+    display: none;
+    position: absolute;
+    background-color: #f9f9f9;
+    min-width: 160px;
+    font-weight: 200;
+    box-shadow: 0px 8px 6px 0px rgba(0,0,0,0.2);
+    padding: 0px 10px;
+    z-index: 1;
+}
+
+.dropdown:hover .dropdown-content {
+    display: block;
+}
+</style>
+<script>
+$(document).ready(function() {
+
+    var divs = $("#h1,h2,h3,h4"); 
+    $.each(divs, function(i,e){
+
+        // Edit
+        var did = $(e).attr('id');
+        var start = '<div class="dropdown more"><span><i class="fa fa-ellipsis-h more" title="Edit"></i></span><div class="dropdown-content">';
+
+        // Edit (assuming deployed under main organization repo)
+        var link = "{{ site.repo }}/edit/master/{{ page.path }}#" + did;
+        var button = "<p><a href='" + link + "' target='_blank'>Edit this page</a></p>";
+        start += button;
+
+        // Issues;
+        var link = "{{ site.repo }}/issues/new?labels={% if page.editable %}{{ page.editable }}{% else %}question{% endif %}&title=Question:&body=Question on: {{ site.repo }}/tree/master/{{ page.path }}%23" + did;
+
+        var button = "<p><a href='" + link + "' target='_blank'>Ask a Question</a></p>";
+        start += button;
+        start += "</div></div>";
+        $(e).append(start)
+
+    })
+});
+</script>

_includes/footer.html

@@ -0,0 +1,45 @@
+<footer class="c-footer md-footer-nav">
+  <div class="u-container c-footer__container">
+    <nav class="md-footer-nav__inner md-grid">
+         {% if page.next.url %}<a href="{{ site.baseurl }}{{ page.next.url }}" title="{{ page.next.title }}" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
+            <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
+              <span class="md-flex__ellipsis">
+                <span class="md-footer-nav__direction">
+                  Next
+                </span>
+                {{ page.next.title }}
+              </span>
+            </div>
+            <div class="md-flex__cell md-flex__cell--shrink">
+              <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
+            </div>
+          </a>{% endif %}
+      </nav>
+    </div>
+
+   <div class="md-footer-meta md-typeset">
+    <div class="md-footer-meta__inner md-grid">
+      <div class="md-footer-copyright">
+
+          <div class="md-footer-copyright__highlight">
+            Copyright &copy; {{ site.time | date: '%Y' }} - {{ site.author }}
+          </div>        
+      </div>
+
+
+  <div class="md-footer-social">
+    <!-- <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css"> -->
+      <a href="https://github.com/{{ site.github_user }}" target="_blank" class="md-footer-social__link fa-brands fa-github"></a>
+      {% if site.matrix %}<a href="https://matrix.to/#/#{{ site.matrix }}" target="_blank" class="md-footer-social__link fa fa-comments"></a>{% endif %}
+      {% if site.mailinglist %}<a href="{{ site.mailinglist }}" target="_blank" class="md-footer-social__link fa fa-envelope"></a>{% endif %}
+      {% if site.dockerhub %}<a href="http://hub.docker.com/r/{{ site.dockerhub }}" class="md-footer-social__link fa" target="_blank">
+        <img src="{{ site.baseurl }}/assets/img/docker-clear.png" style="margin-left:10px" width="20px">
+      </a>{% endif %}
+  </div>
+
+    </div>
+  </div>
+
+</footer>
+
+{% assign slashes = page.url | split: "/" %}