Coder Social home page Coder Social logo

mkdocs-autolinktitle's Introduction

mkdocs-autolinktitle

This MkDocs plugin automatically fetches document titles for Markdown links, streamlining your documentation workflow.

Setup

Install the plugin using pip:

pip install mkdocs-autolinktitle

Activate the plugin in mkdocs.yml:

plugins:
  - search
  - autolinktitle

Note: If you haven't added a plugins entry to your configuration file yet, you will likely want to include the search plugin as well. MkDocs enables it by default if there are no plugins entries set. When adding plugins, you need to enable it explicitly.

Usage

Before:

<path/to/target.md>

After:

[Target Title](path/to/target.md)

Thanks

mkdocs-autolinktitle's People

Contributors

yamionp avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.