Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Added site_author, social card bgcolor, and improved nav controls mkdocs configuration #5230

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

docs: Added site_author, social card bgcolor, and improved nav controls mkdocs configuration #5230

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
56df6bd
docs: Added default site author to html meta tags, improved navigatio…
cwhite911 Feb 27, 2025
137dff6
Update man/mkdocs/mkdocs.yml
cwhite911 Feb 28, 2025
dc21eea
Merge branch 'main' into docs-mkdocs-config
cwhite911 Feb 28, 2025
726ee3c
Merge remote-tracking branch 'upstream/main' into docs-mkdocs-config
cwhite911 Mar 4, 2025
6f68e3a
Removed unneeded comments
cwhite911 Mar 4, 2025
fe53069
Merge branch 'docs-mkdocs-config' of github.com:cwhite911/grass into …
cwhite911 Mar 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions man/mkdocs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
# Project information
site_author: The GRASS Development Team # Default author to all pages
site_name: !ENV SITE_NAME
site_url: https://grass.osgeo.org/grass-stable/manuals/

Expand All @@ -23,19 +24,21 @@ theme:
logo: grass_logo.svg
favicon: favicon.ico
features:
- content.action.edit # Edit on GitHub
- content.action.view
- content.code.copy
- search.suggest
- search.highlight
- content.code.copy
- navigation.footer
- navigation.indexes
# - navigation.expand
- navigation.instant
- navigation.instant.progress
- navigation.tabs
- navigation.tabs.sticky
- content.action.view
- content.action.edit # Edit on GitHub
- navigation.top

palette:
primary: custom
# accent: custom
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clean up comments

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed that comment. Do you mean something else?

icon:
repo: fontawesome/brands/github
edit: material/pencil
Expand All @@ -60,12 +63,8 @@ plugins:
- tags
- social:
cards_layout_options:
background_color: rgb(76, 176, 91)
background_image: null
# - git-revision-date-localized:
# enable_creation_date: true
# - git-committers:
# repository: OSGeo/grass
# branch: main
Comment on lines -64 to -68
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Related?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed this for now because we are adding during the build process. They also have the same issue that the edit on GitHub plugin had where the tool is expecting a different directory structure for the docs and a single repository. The committers part could be cool to add in the future, but I don't think it is a priority at the moment.


# Markdown extensions
markdown_extensions:
Expand Down
Loading