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

Add markdown index support #661

Merged
merged 2 commits into from
Oct 16, 2024

Conversation

robtaylor
Copy link
Collaborator

This PR adds support for generating a top level index in markdown, similar to the HTML publishing backend.

It also contains adding markdown's requirements into its generated docs, mainly by way of an example of usage - I expect this will need some work if it is desirable!

@robtaylor robtaylor force-pushed the markdown-index branch 2 times, most recently from 241a03d to 8567764 Compare September 30, 2024 20:37
@codecov-commenter
Copy link

codecov-commenter commented Sep 30, 2024

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

Codecov Report

Attention: Patch coverage is 97.14286% with 1 line in your changes missing coverage. Please review.

Project coverage is 96.44%. Comparing base (7865edf) to head (2947607).
Report is 9 commits behind head on develop.

Files with missing lines Patch % Lines
doorstop/core/publishers/markdown.py 96.87% 0 Missing and 1 partial ⚠️

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

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #661   +/-   ##
========================================
  Coverage    96.44%   96.44%           
========================================
  Files           40       40           
  Lines         5198     5231   +33     
  Branches      1226     1234    +8     
========================================
+ Hits          5013     5045   +32     
  Misses         110      110           
- Partials        75       76    +1     

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

@robtaylor robtaylor marked this pull request as draft October 2, 2024 22:34
@robtaylor robtaylor force-pushed the markdown-index branch 10 times, most recently from ddd39dd to 7f525a0 Compare October 4, 2024 08:00
@robtaylor robtaylor marked this pull request as ready for review October 4, 2024 08:14
@jacebrowning jacebrowning merged commit a17c0d6 into doorstop-dev:develop Oct 16, 2024
14 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.

3 participants