Skip to content

Commit

Permalink
Update documentation configuration and structure for improved clarity…
Browse files Browse the repository at this point in the history
… and navigation
  • Loading branch information
itSubeDibesh committed Nov 14, 2024
1 parent b329021 commit 97f5f1e
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 12 deletions.
38 changes: 27 additions & 11 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
title: "Cleaner | Dibesh Raj Subedi"
title: " | Cleaner Docs"
description: "A cleaner for developers to clean up their codebase."
logo: "{{ site.baseurl }}/favicon.svg"

permalink: pretty

# Theme settings
remote_theme: "just-the-docs/just-the-docs"
color_scheme: "dark"

Expand All @@ -12,31 +12,47 @@ just_the_docs:
show_last_modified_date: true
collapse_level: 2

# Favicon and theme color
favicon: "{{ site.baseurl }}/favicon.ico"
theme_color: "#000000"
theme_color: "#000000"

# Back to top link
back_to_top: true
back_to_top_text: "Back to top"

footer_content: 'Copyright &copy; 2024 <a href="https://dibe.sh">Dibesh Raj Subedi</a>'
# Footer content
footer_content: 'Copyright &copy; {{ "now" | date: "%Y" }} <a href="https://dibe.sh">Dibesh Raj Subedi</a>'

# Auxiliary links
aux_links:
"Cleaner":
"Cleaner GitHub":
- "https://github.com/dibe-sh/cleaner"
aux_links_new_tab: false

# Navigation settings
nav_enabled: true

nav_title: "Table of Contents"
nav_exclude:
- "docs/README.md"
- "docs/_config.yml"
- "docs/.gitignore"
- "docs/.gitattributes"
- "docs/LICENSE"
- "docs/CONTRIBUTING.md"
- "docs/CHANGELOG.md"
- "docs/CONTRIBUTORS.md"
- "docs/README.md"

# Author information for SEO
author:
name: "Dibesh Raj Subedi"
email: "contact@dibe.sh"
github: "https://github.com/dibe-sh"
linkedin: "https://linkedin.com/in/itsubedibesh"
twitter: "https://twitter.com/itsubedibesh"

# Plugins
plugins:
- jekyll-seo-tag
- jekyll-github-metadata
- jekyll-include-cache
- jekyll-sitemap
- jekyll-seo-tag # Adds SEO meta tags
- jekyll-github-metadata # Pulls GitHub repo metadata for GitHub Pages
- jekyll-include-cache # Caches include statements
- jekyll-sitemap # Generates a sitemap for SEO
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Cleaner"
title: "Home"
layout: home
description: "Automate the cleanup of files and directories that match specific criteria."
nav_order: 1
Expand Down

0 comments on commit 97f5f1e

Please sign in to comment.