GNOME.org
 

[gtk-web/new-website: 104/191] updated documentation

commit c46d62e4fa31a48c18daa12abfcf977dae2b1d7d
Author: ravgeetdhillon <ravgeetdhillon gmail com>
Date:   Mon Jul 15 21:52:56 2019 +0530

    updated documentation

 _data/stuff.yml             |  2 +-
 _includes/footer.html       |  4 +++
 _includes/header.html       | 71 +++++++++++++++++++++++++--------------------
 _layouts/documentation.html |  7 +++--
 4 files changed, 49 insertions(+), 35 deletions(-)
---
diff --git a/_data/stuff.yml b/_data/stuff.yml
index 95e01a5..f03f173 100644
--- a/_data/stuff.yml
+++ b/_data/stuff.yml
@@ -13,7 +13,7 @@ site_repo: https://gitlab.gnome.org/ravgeetdhillon/gtk-web/
 tutorial_video_link: https://www.youtube.com/embed/bNA-Q8fQqTc
 
 #gtk websites logo name
-logo: gtk-logo.ico
+website_logo: gtk-logo.ico
 
 # read out the CONTRIBUTING.md to know how to add documentation pages to the website
 
diff --git a/_includes/footer.html b/_includes/footer.html
index 1c0d9e2..58d27a5 100644
--- a/_includes/footer.html
+++ b/_includes/footer.html
@@ -1,3 +1,7 @@
+<!-- this is the footer file for all the pages in the website -->
+<!-- to make any design changes to the footer section, make changes to this file -->
+<!-- to make changes related to the content, edit the `_data/navigation.yml` -->
+
 <footer class="container-fluid bg-dark navbar-dark text-info py-4 small">
   <div class="container">
     <div class="row">
diff --git a/_includes/header.html b/_includes/header.html
index 715bbd7..875ffe3 100644
--- a/_includes/header.html
+++ b/_includes/header.html
@@ -1,3 +1,8 @@
+<!-- this is the header file for all the pages in the website -->
+<!-- any changes made to this file will affect header section of all the pages -->
+<!-- to make any design changes to the header section, make changes to this file -->
+<!-- to make changes related to the content, edit the `_data/navigation.yml` -->
+
 <!DOCTYPE html>
 <html lang="en" dir="ltr">
 
@@ -10,8 +15,8 @@
        <meta name="author" content="The GTK Team">
        <meta name="description" content="GTK is a highly usable, feature rich toolkit for creating graphical 
user interfaces which boasts cross platform compatibility and an easy to use API. GTK is licensed under the 
GNU LGPL 2.1 allowing development of both free and proprietary software with GTK without any license fees or 
royalties.">
        <meta name="keywords" content="gtk, gtk, gimp, gnome, toolkit, user interface"> 
-       <link rel="icon" href="{{ '/assets/img/' | prepend: site.url | append: site.data.stuff.logo }}" 
type="image/x-icon">
-       <link rel="shortcut icon" href="{{ '/assets/img/' | prepend: site.url | append: site.data.stuff.logo 
}}" type="image/x-icon">
+       <link rel="icon" href="{{ '/assets/img/' | prepend: site.url | append: site.data.stuff.website_logo 
}}" type="image/x-icon">
+       <link rel="shortcut icon" href="{{ '/assets/img/' | prepend: site.url | append: 
site.data.stuff.website_logo }}" type="image/x-icon">
        <title>{{site.title}}</title>
        <link rel="stylesheet" href="{{ '/assets/@fortawesome/fontawesome-free/css/all.min.css' | prepend: 
site.url }}" type="text/css" media="screen" />
        <link rel="stylesheet" href="{{ '/assets/css/markdown.css' | prepend: site.url }}" type="text/css" 
media="screen" />
@@ -21,37 +26,39 @@
        <script src="{{ '/assets/jquery/dist/jquery.min.js' | prepend: site.url }}"></script>
        <script src="{{ '/assets/popper.js/dist/umd/popper.min.js' | prepend: site.url }}"></script>
        <script src="{{ '/assets/bootstrap/dist/js/bootstrap.min.js' | prepend: site.url }}"></script>
-       <script src="{{ '/assets/slick-carousel/slick/slick.min.js' | prepend: site.url }}"></script>
-       
+       <script src="{{ '/assets/slick-carousel/slick/slick.min.js' | prepend: site.url }}"></script>   
 </head>
 
 <body>
-       {% if page.navbar_dark %}
-       <header class="navbar small bg-dark">
-       {% else %}
-       <header class="navbar small">
+  {% if page.navbar_dark %}
+         <header class="navbar small bg-dark">
+  {% else %}
+         <header class="navbar small">
        {% endif %}
-
-               <nav class="container navbar-expand-md px-0 px-md-3">
-                       <a href="/" class="navbar-brand"><img src="{{ '/assets/img/gtk-logo.png' | prepend: 
site.url }}" width="40" height="40" /><strong>GTK</strong></a>
-                       <a class="btn navbar-toggler border-0 p-0" role="button" data-toggle="collapse" 
data-target="#navbarSupportedContent">
-                               <i class="fas fa-ellipsis-h"></i>
-                       </a>
-                       <div class="collapse navbar-collapse" id="navbarSupportedContent">
-                               <ul class="navbar-nav ml-auto">
-                               {% assign menu_links = site.data.navigation.menu_links %}
-                               {% for link in menu_links %}
-                                       {% assign page_split = page.url | split: '/' %}
-                                       {% assign page_type = page_split[1] | capitalize %}
-                                       {% if link.header %}
-                                               {% if page.navbar_dark %}
-                                               <li class="nav-item"><a href="{{ link.href }}" 
class="nav-link text-light float-right">{{ link.name }}</a></li>
-                                               {% else %}
-                                               <li class="nav-item"><a href="{{ link.href }}" 
class="nav-link text-dark float-right">{{ link.name }}</a></li>
-                                               {% endif %}
-                                       {% endif %}
-                               {% endfor %}
-                               </ul>
-                       </div>
-               </nav>
-       </header>
\ No newline at end of file
+  <nav class="container navbar-expand-md px-0 px-md-3">
+    {% if page.navbar_dark %}
+      <a href="/" class="navbar-brand text-white"><img src="{{ '/assets/img/gtk-logo.png' | prepend: 
site.url }}" width="40" height="40" /><strong>GTK</strong></a>
+    {% else %}
+      <a href="/" class="navbar-brand text-dark"><img src="{{ '/assets/img/gtk-logo.png' | prepend: site.url 
}}" width="40" height="40" /><strong>GTK</strong></a>
+    {% endif %}
+    <a class="btn navbar-toggler border-0 p-0" role="button" data-toggle="collapse" 
data-target="#navbarSupportedContent">
+      <i class="fas fa-ellipsis-h"></i>
+    </a>
+    <div class="collapse navbar-collapse" id="navbarSupportedContent">
+      <ul class="navbar-nav ml-auto">
+        {% assign menu_links = site.data.navigation.menu_links %}
+          {% for link in menu_links %}
+            {% assign page_split = page.url | split: '/' %}
+            {% assign page_type = page_split[1] | capitalize %}
+            {% if link.header %}
+              {% if page.navbar_dark %}
+                <li class="nav-item"><a href="{{ link.href }}" class="nav-link text-light float-right">{{ 
link.name }}</a></li>
+              {% else %}
+                <li class="nav-item"><a href="{{ link.href }}" class="nav-link text-dark float-right">{{ 
link.name }}</a></li>
+              {% endif %}
+            {% endif %}
+          {% endfor %}
+      </ul>
+    </div>
+  </nav>
+</header>
\ No newline at end of file
diff --git a/_layouts/documentation.html b/_layouts/documentation.html
index 159d605..b5d49bb 100644
--- a/_layouts/documentation.html
+++ b/_layouts/documentation.html
@@ -1,4 +1,7 @@
-{%- include header.html -%}
+<!-- this is the layout file for the documentation pages -->
+<!-- any changes made to this file will affect all the documentation pages -->
+
+{% include header.html %}
 
 <section class="pb-4" id="{{ page.name }}">
   <div class="container-fluid">
@@ -63,4 +66,4 @@
     $('[data-toggle="tooltip"]').tooltip();
   });
 </script>
-{%- include footer.html -%}
\ No newline at end of file
+{% include footer.html %}
\ No newline at end of file
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]