{"id":16355803,"url":"https://github.com/lyz-code/mkdocs-newsletter","last_synced_at":"2025-05-07T07:34:47.348Z","repository":{"id":37977909,"uuid":"337778965","full_name":"lyz-code/mkdocs-newsletter","owner":"lyz-code","description":"Automatically create newsletters from the changes in a mkdocs repository","archived":false,"fork":false,"pushed_at":"2024-05-27T12:10:11.000Z","size":13948,"stargazers_count":31,"open_issues_count":3,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-11-09T18:41:53.551Z","etag":null,"topics":["mkdocs-newsletter","mkdocs-plugin"],"latest_commit_sha":null,"homepage":"https://lyz-code.github.io/mkdocs-newsletter","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lyz-code.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"docs/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-02-10T16:13:44.000Z","updated_at":"2024-10-13T03:22:00.000Z","dependencies_parsed_at":"2023-01-29T15:31:21.203Z","dependency_job_id":"b7354f95-8e00-4d91-a28e-749ebcf8d95c","html_url":"https://github.com/lyz-code/mkdocs-newsletter","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lyz-code%2Fmkdocs-newsletter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lyz-code%2Fmkdocs-newsletter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lyz-code%2Fmkdocs-newsletter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lyz-code%2Fmkdocs-newsletter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lyz-code","download_url":"https://codeload.github.com/lyz-code/mkdocs-newsletter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225084276,"owners_count":17418374,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mkdocs-newsletter","mkdocs-plugin"],"created_at":"2024-10-11T01:41:49.252Z","updated_at":"2024-11-17T20:05:52.349Z","avatar_url":"https://github.com/lyz-code.png","language":"Python","funding_links":["https://liberapay.com/Lyz/donate","https://ko-fi.com/T6T3GP0V8"],"categories":[],"sub_categories":[],"readme":"# MkDocs Newsletter\n\n[![Actions Status](https://github.com/lyz-code/mkdocs-newsletter/workflows/Tests/badge.svg)](https://github.com/lyz-code/mkdocs-newsletter/actions)\n[![Actions Status](https://github.com/lyz-code/mkdocs-newsletter/workflows/Build/badge.svg)](https://github.com/lyz-code/mkdocs-newsletter/actions)\n[![Coverage Status](https://coveralls.io/repos/github/lyz-code/mkdocs-newsletter/badge.svg?branch=main)](https://coveralls.io/github/lyz-code/mkdocs-newsletter?branch=main)\n\nMkDocs plugin to show the changes of documentation repositories in a user\nfriendly format, at the same time that it's easy for the authors to maintain.\n\nIt creates daily, weekly, monthly and yearly newsletter articles with the\nchanges of each period. Those pages, stored under the `Newsletters` section, are\nfilled with the changes extracted from the commit messages of the git history.\nThe changes are grouped by categories, subcategories and then by file using the\norder of the site's navigation structure. [RSS feeds](rss_feeds.md) are also\ncreated for each newsletter type, so it's easy for people to keep updated with\nthe evolution of the site.\n\nIt assumes that you're using [semantic versioning](https://semver.org/) or our\n[enhanced version](docs/usage.md#commit-message-guidelines) to create your commits. Only\nthose changes that are interesting to the reader will be added to the\nnewsletter. You can use\n[mkdocs-rss-plugin](https://github.com/Guts/mkdocs-rss-plugin) instead if this\nworkflow doesn't feel good.\n\n![ ](screencast.gif)\n\nCheck [a live\nversion](https://lyz-code.github.io/blue-book/newsletter/0_newsletter_index/).\n\n## Help\n\nSee [documentation](https://lyz-code.github.io/mkdocs-newsletter) for more details.\n\n## [Installing](https://lyz-code.github.io/mkdocs-newsletter/install/)\n\nYou should check the [install\ndocs](https://lyz-code.github.io/mkdocs-newsletter/install/), but in short,\nyou'll need to:\n\n```bash\npip install mkdocs-newsletter\n```\n\nAnd enable this plugin, by changing your `mkdocs.yml`.\n\n```yaml\nplugins:\n  - git-revision-date-localized:\n      type: timeago\n  - autolinks\n  - section-index\n  - mkdocs-newsletter\n```\n\n## Contributing\n\nFor guidance on setting up a development environment, and how to make\na contribution to *mkdocs-newsletter*, see [Contributing to\nmkdocs-newsletter](https://lyz-code.github.io/mkdocs-newsletter/contributing).\n\n## Donations\n\n\u003cnoscript\u003e\u003ca href=\"https://liberapay.com/Lyz/donate\"\u003e\u003cimg alt=\"Donate using\nLiberapay\" src=\"https://liberapay.com/assets/widgets/donate.svg\"\u003e\u003c/a\u003e\u003c/noscript\u003e\nor\n[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/T6T3GP0V8)\n\nIf you are using some of my open-source tools, have enjoyed them, and want to\nsay \"thanks\", this is a very strong way to do it.\n\nIf your product/company depends on these tools, you can sponsor me to ensure I\nkeep happily maintaining them.\n\nIf these tools are helping you save money, time, effort, or frustrations; or\nthey are helping you make money, be more productive, efficient, secure, enjoy a\nbit more your work, or get your product ready faster, this is a great way to\nshow your appreciation. Thanks for that!\n\nAnd by sponsoring me, you are helping make these tools, that already help you,\nsustainable and healthy.\n\n## License\n\nGPLv3\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flyz-code%2Fmkdocs-newsletter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flyz-code%2Fmkdocs-newsletter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flyz-code%2Fmkdocs-newsletter/lists"}