Skip to content

Fix markdown parsing for documentation#53

Merged
joe-sharp merged 2 commits intomainfrom
joe-sharp/markdown_docs
Aug 2, 2025
Merged

Fix markdown parsing for documentation#53
joe-sharp merged 2 commits intomainfrom
joe-sharp/markdown_docs

Conversation

@joe-sharp
Copy link
Owner

@joe-sharp joe-sharp commented Aug 2, 2025

This pull request introduces significant improvements to the documentation, feature set, and development infrastructure of the mtg_card_maker gem. Key updates include enhanced README content, better YARD documentation generation, and the addition of advanced features for card customization and development workflows.

Documentation Enhancements:

  • Updated README.md with clearer feature descriptions, advanced customization options, and a new "Technical Architecture" section. This includes improved explanations of mana support, sprite sheet features, and development benefits. [1] [2] [3] [4]
  • Improved YARD documentation generation by adding the redcarpet markup provider and removing outdated exclusions in .yardopts.
  • Minor formatting fixes in docs/MtgCardMaker/BaseCard.html to improve readability and consistency. [1] [2] [3] [4]

Feature Additions:

  • Added support for advanced mana symbols, including hybrid and Phyrexian mana, with detailed notation examples in the documentation.
  • Introduced base64 font embedding for portability and dynamic gradient generation for enhanced card visuals.

Development Infrastructure:

  • Added the redcarpet gem to the development environment for improved markdown rendering in documentation.
  • Updated the README.md to highlight the benefits of using Guard for automated testing and code quality monitoring.

These changes collectively improve the usability, maintainability, and appeal of the mtg_card_maker gem for both developers and end users.

Fixes #50

@joe-sharp joe-sharp requested a review from Copilot August 2, 2025 22:04
Copy link

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 improves markdown parsing for YARD documentation by switching from the default markdown parser to Redcarpet. The change enhances documentation generation, particularly for lists and other markdown elements in both README.md and generated YARD documentation.

Key changes:

  • Updated markdown parser configuration to use Redcarpet for more reliable rendering
  • Regenerated documentation with improved formatting, especially for list structures
  • Added Redcarpet as a development dependency for consistent markdown processing

Reviewed Changes

Copilot reviewed 10 out of 11 changed files in this pull request and generated no comments.

File Description
Gemfile Added redcarpet gem as development dependency
.yardopts Configured Redcarpet as the markdown provider and removed exclusions
README.md Enhanced content structure with better formatting and additional sections
docs/* Regenerated documentation files with improved markdown parsing and timestamps
Comments suppressed due to low confidence (1)

Gemfile:23

  • The version constraint '> 3.6' for redcarpet may be too restrictive. As of my last knowledge update in January 2025, redcarpet version 3.6 was current, but newer versions may be available in August 2025. Consider using a more flexible constraint like '> 3.0' or checking for the latest stable version.
  gem 'redcarpet', '~> 3.6'

@joe-sharp joe-sharp merged commit 39b7f1a into main Aug 2, 2025
4 checks passed
@joe-sharp joe-sharp deleted the joe-sharp/markdown_docs branch August 2, 2025 22:08
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.

[BUG]

1 participant