Skip to main content

anchor_txt: attributes in markdown

anchor_txt adds the ability to embed attributes in markdown files so that external tools can more easily link them to eachother and code, as well as perform other operations.

Use anchor_txt.Section.from_md_path to load a markdown file.

# Markdown Syntax The syntax for anchor_txt attributes is simple.

  • Headers of the form # header {#anchor} will have the anchor tag extracted and available in Header.anchor

  • A header creates a Section, which can have sub sections.

  • Sections have attributes, which are embedded yaml either inline or in fenced code blocks, shown below.

An inline attribute looks like one of these: ` `@{foo}` `@{bar: 2}` `

Fenced code block attributes look like below. They must include the identifier yaml (or json) and end with a @

`yaml @ foo: null bar: 2 `

Attributes blocks within a Section are combined through the same process as dict.update, except overlapping keys throw an error.

# Developer Run make init to create the necessary virtualenv

Run make test for basic tests or make check for lints and formatting.

# License

The source code is Licensed under either of

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Release files for anchor-txt 0.1.6

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

Source distribution (sdist)

Source distribution for anchor-txt 0.1.6
File Size Uploaded
anchor_txt-0.1.6.tar.gz 8.0 kB Details

Release files / anchor_txt-0.1.6.tar.gz

Download URL anchor_txt-0.1.6.tar.gz
Size 8.0 kB
Tags Source
SHA-256 checksum
How to use checksums
b273d971e7191097aab06d47b62f0e6bae84ecb15f251728d9d9188fb30246de
BLAKE2b-256 checksum
How to use checksums
8e013a2595ca59250624ea1fea7be3b5946a72e6bb89e9382eda49c29eb6f8f1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.5

Release history Release notifications | RSS feed

This release

0.1.6 This release

1 release file

0.1.5

1 release file

0.1.4

1 release file

0.1.3

1 release file

0.1.2

1 release file

0.1.1

1 release file

0.1

1 release file

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