Skip to content

Conversation

KyleKing
Copy link
Owner

@KyleKing KyleKing commented Aug 18, 2025

Fixes: #54

Adapted the mdformat-deflist plugin (https://github.com/executablebooks/mdformat-deflist/blob/bbcf9ed4f80847db58b6f932ed95e2c7a6c49ae5/mdformat_deflist/plugin.py) and unit tests for 4-space mkdocs style

@KyleKing KyleKing self-assigned this Aug 18, 2025
@KyleKing KyleKing marked this pull request as ready for review August 18, 2025 12:38
@KyleKing KyleKing requested a review from Copilot August 18, 2025 12:38
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds support for 4-space indented definition lists based on MkDocs Material conventions, addressing issue #54. The implementation adapts the mdformat-deflist plugin to work with the internal formatting system.

  • Implements Material definition list support with 4-space indentation convention
  • Adds comprehensive test coverage for various definition list scenarios
  • Updates dependencies to newer versions including beartype, pytest-cov, and mypy

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
mdformat_mkdocs/mdit_plugins/_material_deflist.py New plugin implementation for Material definition lists with 4-space indentation
mdformat_mkdocs/mdit_plugins/__init__.py Exports the new definition list plugin functions
mdformat_mkdocs/plugin.py Integrates the definition list plugin into the main formatter
tests/render/test_render.py Adds test for definition list rendering
tests/render/fixtures/material_deflist.md Test fixture for Material definition list rendering
tests/format/test_format.py Adds formatting test for definition lists
tests/format/fixtures/material_deflist.md Comprehensive test cases for definition list formatting scenarios
tests/pre-commit-test.md Adds definition list example for manual testing
pyproject.toml Updates test dependencies to newer versions

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@KyleKing KyleKing merged commit b9a5e1a into main Aug 18, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add support for definition lists
1 participant