Skip to main content

A library for building and rendering markdown.

Project description

markdown-dom

🌳 An elegant Python library for handling Markdown with a DOM-like structure

License: MIT Python Version

🌟 Features

  • 🎯 Handle Markdown with a hierarchical DOM-like structure
  • 🔄 Dynamic Markdown generation and management
  • 🧩 Modular structure for high reusability
  • 🎨 Intuitive and easy-to-use API

🚀 Installation

pip install markdown-dom

📖 Usage

from markdown_dom import MarkdownSection, MarkdownSectionTitle

# Create hierarchical structure
doc = MarkdownSection(
    MarkdownSectionTitle("Project Title"),
    MarkdownSection(
        MarkdownSectionTitle("Subsection"),
        "This is a description.",
        MarkdownSection(
            MarkdownSectionTitle("Nested Section"),
            "Description at a deeper level"
        )
    )
)

# Render as Markdown
print(doc.render())

Output:

# Project Title
## Subsection
This is a description.
### Nested Section
Description at a deeper level

🛠️ Requirements

  • Python 3.10 or higher
  • pydantic >= 2.10.3

🤝 Contributing

Contributions are welcome! Feel free to open issues and pull requests.

📜 License

Released under the MIT License. See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

markdown_dom-0.2.0.tar.gz (25.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

markdown_dom-0.2.0-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

Details for the file markdown_dom-0.2.0.tar.gz.

File metadata

  • Download URL: markdown_dom-0.2.0.tar.gz
  • Upload date:
  • Size: 25.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.5

File hashes

Hashes for markdown_dom-0.2.0.tar.gz
Algorithm Hash digest
SHA256 75d8a8a295ec9ee7a4a51956d999ce1c67653034247541fea18add075e294514
MD5 53c926adc1ffc0d4e0bb71e547420afe
BLAKE2b-256 22fb60e08fc50096875c14e23a147529ea0483a0d86552f65aea05fd3834955d

See more details on using hashes here.

File details

Details for the file markdown_dom-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for markdown_dom-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a75f36ebd70fe0aced6b1896ee2bffdc79514b73c5bfd2b6ddeec7863ba495df
MD5 8def6b106b48ab6d1f84a3e8421577f3
BLAKE2b-256 25de2484c220a1258adbcb8641ab0e7183ff5a114fb0f45e6e24f54b63b6117f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page