Add Documentation landing page and sub-pages for libimobiledevice+libplist

Author: nikias

.github/workflows/build-deploy.yml

@@ -74,6 +74,18 @@ jobs:
         with:
           repository: libimobiledevice/libimobiledevice
 
+      - name: Write release tags for libimobiledevice
+        shell: bash
+        run: |
+          mkdir -p data/github/libimobiledevice/libimobiledevice
+          echo '${{ steps.get_releases_libimobiledevice.outputs.releases }} > data/github/libimobiledevice/libimobiledevice/tags.json
+
+      - name: Write release tags for libplist
+        shell: bash
+        run: |
+          mkdir -p data/github/libimobiledevice/libplist
+          echo '${{ steps.get_releases_libplist.outputs.releases }} > data/github/libimobiledevice/libplist/tags.json
+
       - name: Get libplist releases
         uses: yakubique/[email protected]
         id: get_releases_libplist

content/docs/index.md

@@ -0,0 +1,10 @@
+---
+title: Documentation
+layout: docs
+menu:
+  main:
+    weight: 1000
+---
+API documentation is currently available for the following projects:
+- libimobiledevice API: [Latest](docs/libimobiledevice/latest) | [All](docs/libimobiledevice)
+- libplist API: [Latest](docs/libplist/latest) | [All](docs/libplist)

content/docs/libimobiledevice/index.md

@@ -0,0 +1,7 @@
+---
+title: libimobiledevice API documentation
+component: libimobiledevice
+layout: documentation
+hidden: true
+---
+The libimobiledevice API documentation is available for the following releases:

content/docs/libplist/index.md

@@ -0,0 +1,7 @@
+---
+title: libplist API documentation
+component: libplist
+layout: documentation
+hidden: true
+---
+The libplist API documentation is available for the following releases:

layouts/_default/list.html.twig

@@ -9,14 +9,14 @@
 {% extends '_default/page.html.twig' %}
 
 {% block content %}
-{% if page.title != 'index' %}
+{% if page.title and page.title != 'index' %}
     <header>
       <h1>{{ page.title }}</h1>
     </header>
 {% endif %}
     <main>
       {{ page.content }}
-{% for p in pages.all|filter(p => p.exclude is not defined or p.exclude == false) %}
+{% for p in page.pages|filter(p => (p.hidden is not defined or p.hidden == false) and (p.exclude is not defined or p.exclude == false)) %}
       <article>
         <h2><a href="{{ url(p) }}">{{ p.title|e }}</a></h2>
         <time>{{ p.date|date("j M Y") }}</time>

layouts/docs.html.twig

@@ -0,0 +1,7 @@
+{% extends '_default/page.html.twig' %}
+
+{% block content %}
+
+{% include 'partials/section.html.twig' with {"id": "docs", "attr": " bg-white", "heading": "h1"} %}
+
+{% endblock content %}

layouts/documentation.html.twig

@@ -0,0 +1,37 @@
+{% extends '_default/page.html.twig' %}
+
+{% block content %}
+
+{%- set heading = heading is defined ? heading: 'h2' -%}
+{%- set section_title = section_title is defined ? section_title: page.title -%}
+{% block section %}
+<section {% if id is defined %}id="{{ id }}" {% endif %}class="{% block section_classes %}container-fluid{% endblock section_classes %}{% if attr is defined %}{{ attr }}{% endif %}"{% block section_attr %}{% endblock section_attr %}>
+	<div class="container py-4 p-lg-5 px-0">
+		{% block section_header %}
+		<div class="row section-heading mb-4">
+			<div class="col-12">
+				{{ '<%s class="section-title">%s</%s>' | format(heading, section_title, heading) | raw }}
+				<hr>
+			</div>
+		</div>
+		{% endblock section_header %}
+		{% block section_content %}
+		<div class="row">
+			<article class="col-12">
+			<div class="entry-content">{{ page.content }}</div>
+        {% set component = page.component %}
+	{% set tags = site.data.github.libimobiledevice[component].tags %}
+        {% for tag in tags.releases %}
+	<div class="entry-content">
+	    <a href="{{ component }}/{{ tag }}/">{{ component }} {{ tag }}</a>
+	</div>
+	{% endfor %}
+			</article>
+		</div>
+		{% endblock section_content %}
+		{% block section_footer %}{% endblock section_footer %}
+	</div>
+</section>
+{% endblock section %}
+
+{% endblock content %}

layouts/partials/navbar.html.twig

@@ -22,7 +22,7 @@
 
 		<ul class="navbar-nav mr-auto">
 			{% if site.menus.main is defined %}
-			{% for entry in site.menus.main | sort_by_weight %}
+			{% for entry in site.menus.main | sort_by_weight | filter(e => e.weight is not defined or e.weight < 1000) %}
 			<li class="nav-item{% if (url(page) == url(entry.url)) or (entry.url starts with page.section) %} active{% endif %}">
 				<a class="nav-link" href="{{ url(entry.url) }}">{{ entry.name }}{% if url(page) == url(entry.url) %} <span class="sr-only">(current)</span>{% endif %}</a>
 			</li>