https://github.com/hajietewhub/python-markdown-attribute
Markdown attribute modifier (MAM) is a Python tool designed to automate the modification of date (pubDatetime) and cover image (image) attributes in Markdown files.
https://github.com/hajietewhub/python-markdown-attribute
class css datetime image markdown mkdocs nhavantuonglai python python-markdown python-script
Last synced: 9 months ago
JSON representation
Markdown attribute modifier (MAM) is a Python tool designed to automate the modification of date (pubDatetime) and cover image (image) attributes in Markdown files.
- Host: GitHub
- URL: https://github.com/hajietewhub/python-markdown-attribute
- Owner: Hajietewhub
- License: other
- Created: 2025-04-11T13:29:30.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-04-12T09:09:19.000Z (9 months ago)
- Last Synced: 2025-04-13T05:39:50.338Z (9 months ago)
- Topics: class, css, datetime, image, markdown, mkdocs, nhavantuonglai, python, python-markdown, python-script
- Language: Python
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.md
- Code of conduct: code-of-conduct.md
- Security: security.md
Awesome Lists containing this project
README
# Python Markdown Attribute 🐍✍️
  
Markdown Attribute Modifier (MAM) is a Python tool designed to automate the modification of date (`pubDatetime`) and cover image (`image`) attributes in Markdown files. This tool simplifies the process of updating these attributes, making it easier for writers and developers to manage their Markdown documents.
## Table of Contents
1. [Features](#features)
2. [Installation](#installation)
3. [Usage](#usage)
4. [Configuration](#configuration)
5. [Contributing](#contributing)
6. [License](#license)
7. [Contact](#contact)
8. [Releases](#releases)
## Features
- **Automated Date Updates**: Automatically updates the `pubDatetime` attribute in your Markdown files.
- **Image Management**: Easily modifies the `image` attribute to ensure your documents have the correct cover images.
- **Simple Command-Line Interface**: Run commands from your terminal with ease.
- **Cross-Platform Compatibility**: Works on Windows, macOS, and Linux.
- **Lightweight and Fast**: Minimal dependencies for quick setup and execution.
## Installation
To get started with Python Markdown Attribute, follow these steps:
1. **Clone the Repository**:
```bash
git clone https://github.com/Hajietewhub/python-markdown-attribute.git
cd python-markdown-attribute
```
2. **Install Dependencies**:
Ensure you have Python 3.6 or higher installed. You can install the required packages using pip:
```bash
pip install -r requirements.txt
```
3. **Download the Latest Release**:
Visit the [Releases](https://github.com/Hajietewhub/python-markdown-attribute/releases) section to download the latest version. Make sure to execute the downloaded file as per the instructions provided.
## Usage
Using Python Markdown Attribute is straightforward. Here’s how you can use it:
1. **Run the Script**:
Open your terminal and navigate to the directory containing your Markdown files. Run the script with the following command:
```bash
python main.py --file your_markdown_file.md
```
2. **Specify Options**:
You can specify options to modify the `pubDatetime` and `image` attributes:
```bash
python main.py --file your_markdown_file.md --date "2023-10-01" --image "path/to/your/image.jpg"
```
3. **Check the Output**:
After running the command, check your Markdown file to see the updated attributes.
## Configuration
Python Markdown Attribute can be configured to suit your needs. You can create a configuration file (`config.json`) in the root directory with the following structure:
```json
{
"default_date": "2023-10-01",
"default_image": "path/to/default/image.jpg"
}
```
The tool will use these defaults if you do not specify them in the command line.
## Contributing
We welcome contributions to enhance Python Markdown Attribute. If you would like to contribute, please follow these steps:
1. Fork the repository.
2. Create a new branch:
```bash
git checkout -b feature/YourFeature
```
3. Make your changes and commit them:
```bash
git commit -m "Add your feature"
```
4. Push to your branch:
```bash
git push origin feature/YourFeature
```
5. Create a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Contact
For any inquiries or support, please contact the maintainer:
- **Name**: Your Name
- **Email**: your.email@example.com
## Releases
To stay updated with the latest features and fixes, visit the [Releases](https://github.com/Hajietewhub/python-markdown-attribute/releases) section. Download the latest version and execute it to enjoy the improvements.
---
Thank you for checking out Python Markdown Attribute! We hope it simplifies your Markdown management tasks. Happy coding!