Skip to content

feat: add show_footer config option to hide footer - #32

Merged
FernandoCelmer merged 7 commits into
developfrom
feature/28
Aug 16, 2026
Merged

feat: add show_footer config option to hide footer#32
FernandoCelmer merged 7 commits into
developfrom
feature/28

Conversation

@FernandoCelmer

@FernandoCelmer FernandoCelmer commented Mar 25, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Description

Issue: #28

  • mkdocs_dracula_theme/mkdocs_theme.yml: added show_footer: true as a default config key
  • mkdocs_dracula_theme/base.html: wrapped the footer include block with {% if config.theme.show_footer %} conditional

Motivation and Context

Users who want to hide the "Made with Dracula Theme for MkDocs" footer had no native way to do so. Setting show_footer: false in mkdocs.yml now suppresses it cleanly without requiring a custom_dir override.

Closes #28

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation updated (documentation was updated and published)

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules

@FernandoCelmer
FernandoCelmer changed the base branch from main to develop March 25, 2026 00:30
@FernandoCelmer
❤️ TEST: add unit tests for show_footer feature
4ad67fd 
- tests/test_show_footer.py: 6 tests covering default config value,
  footer visibility with show_footer=true/false, and template guard
- pyproject.toml: add pytest, pytest-cov, pyyaml dev dependencies
- .github/workflows/test.yml: CI on Python 3.10/3.11/3.12

Refs #28
FernandoCelmer added a commit that referenced this pull request Mar 25, 2026
@FernandoCelmer
❤️ TEST: move show_footer tests to feature/28
eb56c2a 
test_show_footer.py belongs to PR #32 (feature/28), not here.
feature/29 only contains admonition tests.

Refs #29
@FernandoCelmer
⬆️ CI/CD: Merge develop, reconcile CI infra with show_footer feature
7a20748 
Merged origin/develop (PR #34/#35 CI overhaul) into feature/28. Kept
develop's canonical test.yml/conftest.py/pyproject.toml and layered
the show_footer fixtures (docs_dir, build_site) and mkdocs group deps
on top; regenerated poetry.lock and fixed ruff import ordering in
test_show_footer.py.
@FernandoCelmer
📝 PEP8-#28: Fix import order and formatting in test_show_footer.py
ed00c07
@FernandoCelmer
📘 DOCS-#28: Document show_footer theme setting
06063ed
@FernandoCelmer
❤️ TEST-#28: Add unittest coverage for custom highlight.js config
de57329
@FernandoCelmer
FernandoCelmer merged commit 3cfb9ef into develop Aug 16, 2026
10 checks passed
@FernandoCelmer
FernandoCelmer deleted the feature/28 branch August 16, 2026 20:42
FernandoCelmer added a commit that referenced this pull request Aug 16, 2026
@FernandoCelmer
⬆️ CI/CD: Merge develop, reconcile CI infra with admonition styles
7382c97 
Merged origin/develop (PR #32/#34/#35 CI + show_footer) into feature/29.
Kept develop's canonical test.yml/conftest.py/pyproject.toml layout,
regenerated poetry.lock, and fixed ruff formatting in test_admonitions.py.
@FernandoCelmer FernandoCelmer mentioned this pull request Aug 16, 2026
Closed
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@FernandoCelmer FernandoCelmer

Labels

feature

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

allow hiding footer

2 participants

@FernandoCelmer @actions-user