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.

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

feat: Add Markdown Section Templates #115

Merged
merged 12 commits into from
Aug 21, 2024
Merged

Conversation

eli64s
Copy link
Owner

@eli64s eli64s commented Aug 21, 2024

This PR introduces new Markdown section templates for README generation, improving customization options. Key additions include:

  • Add CLI Option --header-style: Allows selection of README header style. Three templates currently available.
  • Add CLI Option --toc-style: Enables customization of the Table of Contents style. Four templates currently available.
  • Additional codebase restructuring and clean up to prepare for more updates coming soon.

This PR marks the beginning of significantly enhancing the customization of the README generation process!

Cheers,
Eli

@eli64s eli64s added the feature label Aug 21, 2024
@eli64s eli64s merged commit 138998d into main Aug 21, 2024
5 checks passed
@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 84.18367% with 93 lines in your changes missing coverage. Please review.

Project coverage is 86.23%. Comparing base (a886127) to head (2f6a702).
Report is 1 commits behind head on main.

Files Patch % Lines
readmeai/config/settings.py 81.67% 21 Missing and 3 partials ⚠️
readmeai/vcs/url_builder.py 76.08% 10 Missing and 1 partial ⚠️
readmeai/vcs/ingestor.py 83.72% 4 Missing and 3 partials ⚠️
readmeai/__main__.py 84.37% 5 Missing ⚠️
readmeai/models/dalle.py 73.68% 4 Missing and 1 partial ⚠️
readmeai/templates/header.py 80.00% 4 Missing ⚠️
readmeai/templates/toc.py 90.00% 3 Missing and 1 partial ⚠️
readmeai/vcs/errors.py 75.00% 4 Missing ⚠️
readmeai/models/openai.py 78.57% 2 Missing and 1 partial ⚠️
readmeai/parsers/cpp.py 50.00% 3 Missing ⚠️
... and 17 more

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #115      +/-   ##
==========================================
- Coverage   91.94%   86.23%   -5.71%     
==========================================
  Files          39       43       +4     
  Lines        1675     1664      -11     
  Branches        0      264     +264     
==========================================
- Hits         1540     1435     -105     
- Misses        135      169      +34     
- Partials        0       60      +60     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants