[gtk-web/new-website: 92/191] finalized docs structure
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk-web/new-website: 92/191] finalized docs structure
- Date: Thu, 21 Nov 2019 12:26:12 +0000 (UTC)
commit 6315a6fbda183ce75d475b9dc168bfeee99ee3ea
Author: ravgeetdhillon <ravgeetdhillon gmail com>
Date: Fri Jul 12 14:17:22 2019 +0530
finalized docs structure
_config.yml | 2 +
_data/navigation.yml | 2 +-
_data/stuff.yml | 56 ++++++++++++++++++++++++++++
_layouts/documentation.html | 54 +++++++++++----------------
collections/_docs/{tools.md => dev-tools.md} | 0
collections/_docs/eclipse.md | 2 +-
collections/_docs/gnome-builder.md | 2 +-
collections/_docs/mono-develop.md | 2 +-
8 files changed, 83 insertions(+), 37 deletions(-)
---
diff --git a/_config.yml b/_config.yml
index a431272..ae8a45b 100644
--- a/_config.yml
+++ b/_config.yml
@@ -22,6 +22,8 @@ exclude:
- package.json
- package-lock.json
- community.html
+ - README.md
+ - CONTRIBUTING.md
# for dev only
# keep_files: [assets]
diff --git a/_data/navigation.yml b/_data/navigation.yml
index 9b7b92e..2258953 100644
--- a/_data/navigation.yml
+++ b/_data/navigation.yml
@@ -3,7 +3,7 @@ menu_links:
href: /
header: false
footer: true
- section:
+ section: Project
- name: Features
href: /features/
header: true
diff --git a/_data/stuff.yml b/_data/stuff.yml
index 223700f..8a7db9e 100644
--- a/_data/stuff.yml
+++ b/_data/stuff.yml
@@ -37,3 +37,59 @@ news_and_events_list:
description: As regularly as possible, GTK team meetings take place at conferences and
[hackfests](https://wiki.gnome.org/Hackfests) to discuss the future of GTK and define a
[roadmap](https://wiki.gnome.org/Projects/GTK/Roadmap).
- title: Help evolve GTK
description: If you are a developer and want to contribute towards GTK, you are more than welcome to do
so. [Get started now](/docs/) to get some familarity to GTK.
+
+sidebar_sections:
+ - title: Getting Started
+ name: getting-started
+ - title: Installations
+ name: installations
+ - title: Language Bindings
+ name: language-bindings
+ - title: Dev Tools
+ name: dev-tools
+ - title: API References
+ name: apis
+ - title: Architecture
+ name: architecture
+
+sidebar_links:
+ - title: Mono Develop
+ name: mono-develop
+ section: Dev Tools
+ - title: GNOME Builder
+ name: gnome-builder
+ section: Dev Tools
+ - title: Eclipse
+ name: eclipse
+ section: Dev Tools
+ - title: Linux
+ name: linux
+ section: Installations
+ - title: Windows
+ name: windows
+ section: Installations
+ - title: MacOS
+ name: macos
+ section: Installations
+ - title: GTK3
+ name: gtk3
+ section: API References
+ href: https://developer.gnome.org/gtk3/
+ - title: GTK4
+ name: gtk4
+ section: API References
+ - title: GLib, GObject, GIO
+ name: glib
+ section: Architecture
+ - title: GdkPixbuf
+ name: gdkpixbuf
+ section: Architecture
+ - title: Pango
+ name: pango
+ section: Architecture
+ - title: GDK
+ name: gtk
+ section: Architecture
+ - title: Cairo
+ name: cairo
+ section: architecture
\ No newline at end of file
diff --git a/_layouts/documentation.html b/_layouts/documentation.html
index dc2b7fe..5fd04d0 100644
--- a/_layouts/documentation.html
+++ b/_layouts/documentation.html
@@ -6,36 +6,19 @@
<div class="col-lg-3 col-md-4 small p-0 order-2 order-md-1">
<div class="text-break pt-4 px-4 border-right h-100">
<ul class="list-group">
- <li class="list-group-item border-0 group-header pb-4"><a href="#"
class="text-dark"><strong>Get Started</strong></a></li>
- <li class="list-group-item border-0 group-header pb-4"><strong>Installations</strong>
- <ul class="list-group">
- <li class="list-group-item border-0 p-0 pt-2"><a href="#"
class="text-muted">Linux</a></li>
- <li class="list-group-item border-0 p-0 pt-2"><a href="#"
class="text-muted">Windows</a></li>
- <li class="list-group-item border-0 p-0 pt-2"><a href="#"
class="text-muted">MacOS</a></li>
- </ul>
- </li>
- <li class="list-group-item border-0 group-header pb-4"><a href="#"
class="text-dark"><strong>Language Bindings</strong></a></li>
- <li class="list-group-item border-0 group-header pb-4"><strong>Dev tools</strong>
- <ul class="list-group">
- <li class="list-group-item border-0 p-0 pt-2"><a href="#mono-develop"
class="text-muted">Mono Develop</a></li>
- <li class="list-group-item border-0 p-0 pt-2"><a href="#gnome-builder"
class="text-muted">GNOME Builder</a></li>
- <li class="list-group-item border-0 p-0 pt-2"><a href="#gnome-builder"
class="text-muted">Eclipse IDE</a></li>
- </ul>
- </li>
- <li class="list-group-item border-0 group-header pb-4"><strong>API
References</strong>
- <ul class="list-group">
- <li class="list-group-item border-0 p-0 pt-2"><a
href="https://developer.gnome.org/gtk3/" class="text-muted">GTK3</a></li>
- <li class="list-group-item border-0 p-0 pt-2"><a
href="https://developer.gnome.org/gtk4/" class="text-muted">GTK4</a></li>
- </ul>
- </li>
- <li class="list-group-item border-0 group-header pb-4"><strong>Architecture</strong>
- <ul class="list-group">
- <li class="list-group-item border-0 p-0 pt-2"><a href="#"
class="text-muted">GLib, GObject, GIO</a></li>
- <li class="list-group-item border-0 p-0 pt-2"><a href="#"
class="text-muted">GdkPixbuf</a></li>
- <li class="list-group-item border-0 p-0 pt-2"><a href="#"
class="text-muted">Pango</a></li>
- <li class="list-group-item border-0 p-0 pt-2"><a href="#"
class="text-muted">GDK</a></li>
- <li class="list-group-item border-0 p-0 pt-2"><a href="#"
class="text-muted">Cairo</a></li>
- </ul>
+ {% for section in site.data.stuff.sidebar_sections %}
+ <li class="list-group-item border-0 group-header pb-4"><a href="/docs/{{
section.name }}" class="text-dark"><strong>{{ section.title }}</strong></a>
+ {% assign sidebar_links = site.data.stuff.sidebar_links | where: "section",
section.title %}
+ <ul class="list-group">
+ {% for link in sidebar_links %}
+ {% if link.href %}
+ <li class="list-group-item border-0 p-0 pt-2"><a href="{{
link.href }}" class="text-muted">{{ link.title }}</a></li>
+ {% else %}
+ <li class="list-group-item border-0 p-0 pt-2"><a href="/docs/{{
section.name }}/{{ link.name }}" class="text-muted">{{ link.title }}</a></li>
+ {% endif %}
+ {% endfor %}
+ </ul>
+ {% endfor %}
</li>
</ul>
</div>
@@ -45,9 +28,14 @@
<div class="w-100">
<nav aria-label="breadcrumb">
<ol class="breadcrumb small bg-transparent pl-0 m-0">
- <li class="breadcrumb-item"><a href="#">Docs</a></li>
- <li class="breadcrumb-item"><a href="#">Dev Tools</a></li>
- <li class="breadcrumb-item active" aria-current="page">GNOME Builder</li>
+ {% assign url = page.url | split: '/' %}
+ {% for part in url %}
+ {% if forloop.last == true %}
+ <li class="breadcrumb-item active" aria-current="page">{{ part
}}</li>
+ {% else %}
+ <li class="breadcrumb-item"><a href="#">{{ part }}</a></li>
+ {% endif %}
+ {% endfor %}
</ol>
</nav>
</div>
diff --git a/collections/_docs/tools.md b/collections/_docs/dev-tools.md
similarity index 100%
rename from collections/_docs/tools.md
rename to collections/_docs/dev-tools.md
diff --git a/collections/_docs/eclipse.md b/collections/_docs/eclipse.md
index 0faf448..c61c5d0 100644
--- a/collections/_docs/eclipse.md
+++ b/collections/_docs/eclipse.md
@@ -1,5 +1,5 @@
---
-permalink: /docs/tools/:name
+permalink: /docs/dev-tools/:name
---
# Eclipse
diff --git a/collections/_docs/gnome-builder.md b/collections/_docs/gnome-builder.md
index 68e7a4b..2b994a2 100644
--- a/collections/_docs/gnome-builder.md
+++ b/collections/_docs/gnome-builder.md
@@ -1,5 +1,5 @@
---
-permalink: /docs/tools/:name
+permalink: /docs/dev-tools/:name
---
# GNOME Builder
diff --git a/collections/_docs/mono-develop.md b/collections/_docs/mono-develop.md
index 41d1524..e1c0f1c 100644
--- a/collections/_docs/mono-develop.md
+++ b/collections/_docs/mono-develop.md
@@ -1,5 +1,5 @@
---
-permalink: /docs/tools/:name
+permalink: /docs/dev-tools/:name
---
# Mono Develop
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]