mdfy 0.0.3

Effortlessly convert nested Python dictionaries into intuitive Markdown tables.

mdfy

Transform text into beautiful markdown, effortlessly.

🌟 Features

• Simplicity: Just a few lines of code and voila! An intuitive architecture made simple.
• Modulability: Each module is highly independent, making it easy to use on its own.
• Customizable: Extensible design allowing for easy customization.
• Highly Tested: Robust unit tests ensure reliability.

🚀 Getting Started

Installation

pip install mdfy

Usage

Here's a quick start guide to get you up and running!

from mdfy import Mdfier, MdText, MdHeader

contents = [
  MdHeader("Hello, MDFY!"),
  MdText("[Life:bold] is [like:italic] a bicycle.")
]
Mdfy("markdown.md").write(contents)

# => markdown.md
#
# # Hello, MDFY!
# **Life** is *like* a bicycle.

Each mdfy element is string-convertible and can operate independently!

from mdfy import MdText, MdHeader, MdTable

print(MdHeader("Hello, MDFY!"))
print(MdText("[Life:bold] is [like:italic] a bicycle."))
print(MdTable({"head1": "content", "head2": "content"}, transpose=True))

# => result
#
# # Hello, MDFY!
# **Life** is *like* a bicycle.
# | Key | Value |
# | --- | --- |
# | head1 | content |
# | head2 | content |

MdText の記法

📖 Documentation

Check out our full documentation for detailed guides and API references.

✅ Testing

To run the tests:

python -m pytest

💡 Contributing

We welcome contributions!

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

---