{"id":13573572,"url":"https://github.com/zachhannum/mkdocs-autolinks-plugin","last_synced_at":"2025-04-12T11:44:32.653Z","repository":{"id":38205424,"uuid":"233902628","full_name":"zachhannum/mkdocs-autolinks-plugin","owner":"zachhannum","description":"An MkDocs plugin that automagically generates relative links between markdown pages","archived":false,"fork":false,"pushed_at":"2024-04-02T11:27:28.000Z","size":22,"stargazers_count":84,"open_issues_count":11,"forks_count":31,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-26T06:34:24.594Z","etag":null,"topics":["documentation","markdown","mkdocs","plugin"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/mkdocs-autolinks-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/zachhannum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2020-01-14T17:57:51.000Z","updated_at":"2025-03-25T03:56:14.000Z","dependencies_parsed_at":"2024-01-14T03:51:59.557Z","dependency_job_id":"714f0642-e4ad-446e-a03b-bbc27a4f9b9f","html_url":"https://github.com/zachhannum/mkdocs-autolinks-plugin","commit_stats":null,"previous_names":["midnightprioriem/mkdocs-autolinks-plugin"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zachhannum%2Fmkdocs-autolinks-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zachhannum%2Fmkdocs-autolinks-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zachhannum%2Fmkdocs-autolinks-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zachhannum%2Fmkdocs-autolinks-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zachhannum","download_url":"https://codeload.github.com/zachhannum/mkdocs-autolinks-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248564175,"owners_count":21125406,"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":["documentation","markdown","mkdocs","plugin"],"created_at":"2024-08-01T15:00:37.774Z","updated_at":"2025-04-12T11:44:32.632Z","avatar_url":"https://github.com/zachhannum.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# MkDocs Autolinks Plugin\n\nAn MkDocs plugin that simplifies relative linking between documents.\n\nThe Autolinks plugins allows you to link to pages and images within your MkDocs site without provided the entire relative path to the file in your document structure.\n\n## Setup \n\nInstall the plugin using pip:\n\n`pip install mkdocs-autolinks-plugin`\n\nActivate the plugin in `mkdocs.yml`:\n```yaml\nplugins:\n  - search\n  - autolinks \n```\n\n\u003e **Note:** 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, but now you have to enable it explicitly.\n\nMore information about plugins in the [MkDocs documentation](https://www.mkdocs.org/dev-guide/plugins/).\n\n\n## Usage\n\nTo use this plugin, simply create a link that only contains the filename of file you wish to link to.\n\nFor example, say you have a document structure like this:\n\n```\ndocs/\n├── guides/\n│   ├── onboarding.md\n│   └── syntax_guide.md\n├── software/\n│   ├── git_flow.md\n│   └── code_reviews.md\n└── images/\n    ├── avatar.png\n    └── example.jpg\n```\n\nNormally, if you want create a link to `git_flow.md` from inside `onboarding.md`, you would need to provide the relative path:\n\n```markdown\n# onboarding.md\n[Git Flow](../software/git_flow.md)\n```\n\nThis link is fragile; if someone decides to rearrange the site structure, all of these relative links break. Not to mention having to figure out the relative path.\n\nWith the Autolinks plugin, you simply need to provide the filename you wish to link to. The plugin will pre-process all of your markdown files and replace the filename with the correct relative path, given that the file exists in your document structure:\n\n```markdown\n# onboarding.md\n[Git Flow](git_flow.md)\n```\n\nThe Autolinks plugin works with the following extension types:\n\n* md\n* png\n* jpg\n* jpeg\n* bmp\n* gif\n* svg\n* webp\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzachhannum%2Fmkdocs-autolinks-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzachhannum%2Fmkdocs-autolinks-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzachhannum%2Fmkdocs-autolinks-plugin/lists"}