{"id":15017497,"url":"https://github.com/timvink/mkdocs-git-authors-plugin","last_synced_at":"2025-04-06T18:16:58.963Z","repository":{"id":36705237,"uuid":"229729034","full_name":"timvink/mkdocs-git-authors-plugin","owner":"timvink","description":"MkDocs plugin to display git authors of a page.","archived":false,"fork":false,"pushed_at":"2024-04-15T19:30:53.000Z","size":616,"stargazers_count":67,"open_issues_count":11,"forks_count":17,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-05-01T22:44:58.327Z","etag":null,"topics":["git","mkdocs","mkdocs-plugin"],"latest_commit_sha":null,"homepage":"https://timvink.github.io/mkdocs-git-authors-plugin","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/timvink.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["timvink"]}},"created_at":"2019-12-23T10:24:38.000Z","updated_at":"2024-05-08T14:49:37.337Z","dependencies_parsed_at":"2024-05-08T14:49:31.286Z","dependency_job_id":"8c18cbf6-09d0-410c-a812-ef29e6762c74","html_url":"https://github.com/timvink/mkdocs-git-authors-plugin","commit_stats":{"total_commits":166,"total_committers":6,"mean_commits":"27.666666666666668","dds":0.3614457831325302,"last_synced_commit":"2380bb1b25a250650c78121192640a1ba27a1fac"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-git-authors-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-git-authors-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-git-authors-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-git-authors-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timvink","download_url":"https://codeload.github.com/timvink/mkdocs-git-authors-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247526768,"owners_count":20953143,"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":["git","mkdocs","mkdocs-plugin"],"created_at":"2024-09-24T19:50:34.112Z","updated_at":"2025-04-06T18:16:58.930Z","avatar_url":"https://github.com/timvink.png","language":"Python","funding_links":["https://github.com/sponsors/timvink"],"categories":[],"sub_categories":[],"readme":"[![Actions Status](https://github.com/timvink/mkdocs-git-authors-plugin/workflows/pytest/badge.svg)](https://github.com/timvink/mkdocs-git-authors-plugin/actions)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocs-git-authors-plugin)\n![PyPI](https://img.shields.io/pypi/v/mkdocs-git-authors-plugin)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/mkdocs-git-authors-plugin)\n[![codecov](https://codecov.io/gh/timvink/mkdocs-git-authors-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/timvink/mkdocs-git-authors-plugin)\n![GitHub contributors](https://img.shields.io/github/contributors/timvink/mkdocs-git-authors-plugin)\n![PyPI - License](https://img.shields.io/pypi/l/mkdocs-git-authors-plugin)\n\n# mkdocs-git-authors-plugin\n\nLightweight [MkDocs](https://www.mkdocs.org/) plugin to display git authors of a markdown page:\n\n\u003e Authors: Jane Doe, John Doe\n\nSee the [demo](https://timvink.github.io/mkdocs-git-authors-plugin/). The plugin only considers authors of the current lines in the page ('surviving code' using `git blame`).\n\nOther MkDocs plugins that use information from git:\n\n- [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin) for displaying the last revision date\n- [mkdocs-git-committers-plugin](https://github.com/byrnereese/mkdocs-git-committers-plugin) for displaying authors' github user profiles\n\n## Setup\n\nInstall the plugin using pip3:\n\n```bash\npip3 install mkdocs-git-authors-plugin\n```\n\nNext, add the following lines to your `mkdocs.yml`:\n\n```yml\nplugins:\n  - search\n  - git-authors\n```\n\n\u003e If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set.\n\nYou can then use the `{{ git_page_authors }}` tag in your markdown document, or choose to customize your mkdocs theme (see [usage](https://timvink.github.io/mkdocs-git-authors-plugin/usage.html) page in the docs).\n\n### Note when using build environments\n\nThis plugin needs access to the last commit that touched a specific file to be able to retrieve the date. By default many build environments only retrieve the last commit, which means you might need to:\n\u003cdetails\u003e\n  \u003csummary\u003eChange your CI settings\u003c/summary\u003e\n  \n  - github actions: set `fetch_depth` to `0` ([docs](https://github.com/actions/checkout))\n  - gitlab runners: set `GIT_DEPTH` to `0` ([docs](https://docs.gitlab.com/ee/ci/pipelines/settings.html#limit-the-number-of-changes-fetched-during-clone))\n  - bitbucket pipelines: set `clone: depth: full` ([docs](https://support.atlassian.com/bitbucket-cloud/docs/configure-bitbucket-pipelinesyml/))\n\u003c/details\u003e\n\n\n## Documentation\n\nSee [timvink.github.io/mkdocs-git-authors-plugin](https://timvink.github.io/mkdocs-git-authors-plugin/)\n\n## Contributing\n\nVery much open to contributions! Please read [contributing guide](https://timvink.github.io/mkdocs-git-authors-plugin/contributing.html) before putting in any work.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimvink%2Fmkdocs-git-authors-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimvink%2Fmkdocs-git-authors-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimvink%2Fmkdocs-git-authors-plugin/lists"}