Skip to main content

A library to analyze markdown files

Project description

mrkdwn_analysis

mrkdwn_analysis is a Python library designed to analyze Markdown files. With its powerful parsing capabilities, it can extract and categorize various elements within a Markdown document, including headers, sections, links, images, blockquotes, code blocks, and lists. This makes it a valuable tool for anyone looking to parse Markdown content for data analysis, content generation, or for building other tools that utilize Markdown.

Features

  • Extract and categorize various elements of a Markdown file.
  • Handle both inline and reference-style links and images.
  • Recognize different types of headers and sections.
  • Identify and extract code blocks, even nested ones.
  • Handle both ordered and unordered lists, nested or otherwise.
  • A simple API that makes parsing Markdown documents a breeze.

Usage

Using mrkdwn_analysis is simple. Just import the MarkdownAnalyzer class, create an instance with your Markdown file, and you're good to go!

from mrkdwn_analysis import MarkdownAnalyzer

analyzer = MarkdownAnalyzer("path/to/your/markdown.md")

headers = analyzer.identify_headers()
sections = analyzer.identify_sections()
...

Installation

You can install mrkdwn_analysis from PyPI:

pip install mrkdwn_analysis

We hope mrkdwn_analysis helps you with all your Markdown analyzing needs!

Contributions

Contributions are always welcome! If you have a feature request, bug report, or just want to improve the code, feel free to create a pull request or open an issue.

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_analysis-0.0.2.tar.gz (3.3 kB view hashes)

Uploaded Source

Built Distribution

markdown_analysis-0.0.2-py3-none-any.whl (3.8 kB view hashes)

Uploaded Python 3

Supported by

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