Skip to main content

Autolink

Autolink is a command-line utility that automatically discovers tags and creates cross-links between your Markdown files, turning your collection of notes into a navigable personal wiki.

Description

This tool is designed for anyone who maintains a personal knowledge base, a digital garden, or a Zettelkasten-style system using Markdown files. It works by:

  1. Scanning your files to find tags from various sources (like # Headers, [[wikilinks]], and a special [tags]:# (...) comment).
  2. Automatically converting occurrences of these tags into reference-style Markdown links ([tag][tag]).
  3. Maintaining a central linklist.md, and a tag_index.json file that contains all the link definitions, pointing each tag to its canonical source file.

This process helps you build a rich, interconnected web of knowledge without the manual effort of creating and updating links.

Installation

You can install Autolink directly from the repository using pip:

pip install autolink-md

Usage

Provide a simple example of how to use your library.

# Example Usage of Autolink
import os
import autolink

path = os.path.realpath("my_folder")
initialize_tagging(path)

there are 3 commands:

  1.  $autolink init path ./path/to/folder
    
  2.  $autolink update path ./path/to/folder
    
  3.  $autolink rename --old old_tag --new new_tag path ./path/to/folder
    

Metadata

Release files for autolink-md 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for autolink-md 0.1.0
File Size Uploaded Provenance
autolink_md-0.1.0.tar.gz 54.1 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for autolink-md 0.1.0
File Interpreter ABI Platform
autolink_md-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 91.0 kB

Security for autolink-md 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page