Merge pull request #86 from diamant3/seo-config

sharkwouter · web-flow · commit 4fbc5f7b547f · 2025-04-04T14:06:33.000+02:00
SEO: Improvements using _config.yml
diff --git a/Gemfile b/Gemfile
@@ -1,4 +1,8 @@
 source 'https://rubygems.org'
 
-gem "jekyll"
-gem "just-the-docs"
+gem "jekyll" # static site generator used
+gem "just-the-docs" # Jekyll theme used
+gem "jekyll-seo-tags" # adds SEO metadata to improve search engine visibility
+gem "jekyll-github-metadata" # fetches repo data for use in Jekyll
+gem "jekyll-include-cache" # caches included files to speed up site gen or load
+gem "jekyll-sitemap" # generate sitemap to help search engines index the site
diff --git a/_config.yml b/_config.yml
@@ -1,6 +1,7 @@
 title: PSPDEV
-description: "Development tools for the Playstation Portable"
+description: "An open source SDK for PlayStation Portable (PSP) development. It allows you to make apps and games for both custom and official firmwares. This is a community project made by enthusiasts, it is in no way affiliated with Sony."
 theme: just-the-docs
+url: "https://pspdev.github.io"
 
 # just-the-docs configuration
 favicon_ico: /images/pspdev.ico
@@ -17,3 +18,21 @@ nav_external_links:
   - title: "PSPDEV's package index"
     url: "https://pspdev.github.io/psp-packages/"
     opens_in_new_tab: true
+
+back_to_top: true
+back_to_top_text: "Back to top"
+
+footer_content: 'Copyright &copy; 2025, PSPDEV. Distributed by <a href="https://github.com/pspdev/pspdev.github.io/blob/master/LICENSE">The Unlicense.</a>'
+
+# Footer "Edit this page on GitHub" link text
+gh_edit_link: true # show or hide edit this page link
+gh_edit_link_text: "Edit this page on GitHub"
+gh_edit_repository: "https://github.com/pspdev/pspdev.github.io" # the github URL for your repo
+gh_edit_branch: "master" # the branch that your docs is served from
+# gh_edit_source: docs # the source that your files originate from
+gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
+
+plugins:
+  - jekyll-seo-tag
+  - jekyll-github-metadata
+  - jekyll-sitemap
diff --git a/_includes/head.html b/_includes/head.html
@@ -0,0 +1,30 @@
+<head>
+  <meta charset="UTF-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=Edge">
+
+  <link rel="stylesheet" href="{{ '/assets/css/just-the-docs-default.css' | relative_url }}">
+  <link rel="stylesheet" href="{{ '/assets/css/just-the-docs-head-nav.css' | relative_url }}" id="jtd-head-nav-stylesheet">
+
+  <style id="jtd-nav-activation">
+    {% include css/activation.scss.liquid %}
+  </style>
+
+  {% if site.search_enabled != false %}
+    <script src="{{ '/assets/js/vendor/lunr.min.js' | relative_url }}"></script>
+  {% endif %}
+
+  <script src="{{ '/assets/js/just-the-docs.js' | relative_url }}"></script>
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>{{ page.title }} | PSP SDK: Development tools for the Playstation Portable</title>
+
+  <!-- Uncomment to conditionally change the <title> content  -->
+  <!-- {% if page.title == "Home" %}
+    <title>{{ page.title }} | PSP SDK: Development tools for the Playstation Portable</title>
+  {% endif %}
+
+  {% if page.title != "Home" %}
+    <title>{{ page.title }} | {{ site.title }}</title>
+  {% endif %} -->
+
+  {% seo title=false %}
+</head>
diff --git a/tips_tricks.md b/tips_tricks.md
@@ -88,7 +88,7 @@ If you're not sure what the library you used is called exactly, you can use the
 psp-create-license-directory -l
 ```
 
-## Updating the Toolchain
+## Updating the PSP SDK
 {: .fs-6 .fw-700 }
 
 A new version of the PSP SDK is released at least once a month, so updating should be done regularly if you want to benefit from new features and bug fixes.
