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 project: mkdocs_github_changelog #177

Merged
merged 3 commits into from
Jan 4, 2024

Conversation

djpugh
Copy link
Contributor

@djpugh djpugh commented Dec 27, 2023

What kind of change does this PR introduce?

  • Add a project
  • Update a project
  • Remove a project
  • Add or update a category
  • Change configuration
  • Documentation
  • Other, please describe:

Description:

Adding mkdocs_github_changelog - Automatically generate changelog from github releases (works well with Release Drafter)

Checklist:

  • I have read the CONTRIBUTING guidelines.
  • I have not modified the README.md file. Projects are only supposed to be added or updated within the projects.yaml file since the README.md file is automatically generated.

@oprypin
Copy link
Contributor

oprypin commented Dec 27, 2023

The implementation looks so good, curious where did you learn to add a Markdown extension in that way? 🙂

projects.yaml Outdated Show resolved Hide resolved
@djpugh
Copy link
Contributor Author

djpugh commented Dec 27, 2023

The implementation looks so good, curious where did you learn to add a Markdown extension in that way? 🙂

I'm pretty new to mkdocs plugins so started with an implementation based on mkdocstrings as that was kind of doing something similar

@djpugh djpugh requested a review from oprypin December 27, 2023 18:12
Copy link
Collaborator

@pawamoy pawamoy left a comment

Choose a reason for hiding this comment

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

Thanks for updating the category. Could you also move the entry at the end of this same category, so that items are correctly grouped by category?

@djpugh djpugh requested a review from pawamoy January 4, 2024 21:42
@djpugh
Copy link
Contributor Author

djpugh commented Jan 4, 2024

@pawamoy should be in the right place now!

Copy link
Collaborator

@pawamoy pawamoy left a comment

Choose a reason for hiding this comment

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

Thanks!

@pawamoy pawamoy merged commit a0b1c38 into mkdocs:main Jan 4, 2024
1 check 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