Markdown dosyalarını modüler bir şekilde yönetmenizi sağlayan araç
Project description
Markdown İmporter 📝
Bu araç, markdown dosyalarınızı modüler bir şekilde yönetmenizi sağlar. Markdown dosyalarınızı parçalara ayırıp, ana dosyanızda import edebilirsiniz.
📥 Kurulum
pip install markdown-importer
🚀 Özellikler
- Markdown dosyalarını modüler hale getirme
- Çoklu dil desteği (Türkçe/İngilizce)
- Eksik dosya kontrolü ve bildirimi
- Esnek import sözdizimi
- Otomatik senkronizasyon
🛠️ Kullanım
1. Markdown Dosyasını Hazırlama
Kaynak markdown dosyanızda import etmek istediğiniz dosyaları belirtin:
<!-- @import "docs/api/auth/readme.md" -->
2. Çalıştırma
# Varsayılan ayarlarla
markdown-importer
# Özel parametrelerle
markdown-importer -e README.editor.md -g README.github.md -l tr
3. Parametreler
| Parametre | Kısa | Uzun | Varsayılan | Açıklama |
|---|---|---|---|---|
| Kaynak Dosya | -e | --editor-file | README.editor.md | İmport direktiflerini içeren kaynak dosya |
| Hedef Dosya | -g | --github-file | README.github.md | Oluşturulacak sonuç dosyası |
| Temel Dizin | -b | --base-dir | . | İmport edilecek dosyaların aranacağı dizin |
| Dil | -l | --language | tr | Kullanılacak dil (tr: Türkçe, en: İngilizce) |
🌍 Dil Desteği
- 🇹🇷 Türkçe (
-l tr) - 🇬🇧 İngilizce (
-l en)
⚠️ Hata Yönetimi
- Eksik dosyalar
[Missing File]olarak işaretlenir - Her hata detaylı olarak raporlanır
- İşlem sonucu özeti sunulur
Markdown Importer 📝
This tool allows you to manage your markdown files in a modular way. You can split your markdown files into pieces and import them into your main file.
📥 Installation
pip install markdown-importer
🚀 Features
- Modular markdown file management
- Multi-language support (Turkish/English)
- Missing file checks and notifications
- Flexible import syntax
- Automatic synchronization
🛠️ Usage
1. Prepare Markdown File
Specify the files you want to import in your source markdown file:
<!-- @import "docs/api/auth/readme.md" -->
2. Running
# With default settings
markdown-importer
# With custom parameters
markdown-importer -e README.editor.md -g README.github.md -l en
3. Parameters
| Parameter | Short | Long | Default | Description |
|---|---|---|---|---|
| Source File | -e | --editor-file | README.editor.md | Source file containing import directives |
| Target File | -g | --github-file | README.github.md | Result file to be created |
| Base Directory | -b | --base-dir | . | Directory to search for imported files |
| Language | -l | --language | tr | Language to use (tr: Turkish, en: English) |
🌍 Language Support
- 🇹🇷 Turkish (
-l tr) - 🇬🇧 English (
-l en)
⚠️ Error Handling
- Missing files are marked as
[Missing File] - Each error is reported in detail
- Summary of process result is provided
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file markdown_importer-1.0.1.tar.gz.
File metadata
- Download URL: markdown_importer-1.0.1.tar.gz
- Upload date:
- Size: 5.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
34ea12830b944a1a1d92f8a4e81295b55cb4c8f16910024fc44327cc46bba31c
|
|
| MD5 |
12efadc443d286957082196f8a302d16
|
|
| BLAKE2b-256 |
c6846a551659bc5d647ddea0d76c128c86612acbda97fb51b209d41890506fda
|
File details
Details for the file markdown_importer-1.0.1-py3-none-any.whl.
File metadata
- Download URL: markdown_importer-1.0.1-py3-none-any.whl
- Upload date:
- Size: 6.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
60a511cc8ecc418a10385332afabe0bbee321c046e3b63692fe6d8a98e727f2c
|
|
| MD5 |
70408673f094ce997dcabd773ccf0143
|
|
| BLAKE2b-256 |
9e8d33d657000acc978f7025a7f8f3a56628c945f4396202db7aa2bb84d2e823
|