https://github.com/cmitu/mkdocs-altlink-plugin

An MkDocs plugin that simplifies internal links creation
https://github.com/cmitu/mkdocs-altlink-plugin

markdown mkdocs wiki

Last synced: about 1 month ago
JSON representation

An MkDocs plugin that simplifies internal links creation

• Host: GitHub
• URL: https://github.com/cmitu/mkdocs-altlink-plugin
• Owner: cmitu
• License: mit
• Created: 2020-01-08T21:31:28.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-07-13T17:28:57.000Z (over 2 years ago)
• Last Synced: 2023-03-06T16:18:09.709Z (almost 2 years ago)
• Topics: markdown, mkdocs, wiki
• Language: Python
• Homepage:
• Size: 11.7 KB
• Stars: 4
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Alternate Link

*An MkDocs plugin that simplifies internal links*

Alternate Links is a very simple [mkdocs plugin](http://www.mkdocs.org/user-guide/plugins/) to enable an

alternate syntax for internal links, removing the need to add the `.md` suffix for the target page.

 

## Quick start

Install the plugin with pip.

``` bash

pip install git+https://github.com/cmitu/mkdocs-altlink-plugin/

```

Enable the plugin in your `mkdocs.yml`:

```yaml

plugins:

    - search

    - alternate-link

```

> **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.

More information about plugins in the [MkDocs documentation][mkdocs-plugins]

## Usage

When creating an internal Markdown link, you can omit the `.md` extension for the target page:

* `[My Page](source-page.md)` can be written as `[My Page](source-page)`

* `[My Page](source-page.md#Point)` can be written as `[My Page](source-page#Point)`

[mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/