Skip to main content

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.

🚀 Ö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. Import etmek istediğiniz dosyayı belirtin:
<!-- @import "docs/api/auth/readme.md" -->
  1. Scripti çalıştırın:
python _markdown_sync.py
  1. Script otomatik olarak:
    • İmport edilen dosyaları bulur
    • İçerikleri ana dosyaya ekler
    • Eksik dosyaları bildirir
    • Sonuç dosyasını oluşturur

⚙️ Yapılandırma

markdown_sync = MarkdownSync(
    editor_file="README.editor.md",    # Kaynak dosya
    github_file="README.github.md",    # Hedef dosya
    base_dir=".",                      # Temel dizin
    language=Language.TURKISH          # Dil seçeneği
)

🌍 Dil Desteği

  • 🇹🇷 Türkçe (Language.TURKISH)
  • 🇬🇧 İngilizce (Language.ENGLISH)

⚠️ 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.

🚀 Features

  • Modular markdown file management
  • Multi-language support (Turkish/English)
  • Missing file checks and notifications
  • Flexible import syntax
  • Automatic synchronization

🛠️ Usage

  1. Specify the file you want to import:
<!-- @import "docs/api/auth/readme.md" -->
  1. Run the script:
python _markdown_sync.py
  1. The script automatically:
    • Finds imported files
    • Adds contents to main file
    • Reports missing files
    • Creates result file

⚙️ Configuration

markdown_sync = MarkdownSync(
    editor_file="README.editor.md",    # Source file
    github_file="README.github.md",    # Target file
    base_dir=".",                      # Base directory
    language=Language.ENGLISH          # Language option
)

🌍 Language Support

  • 🇹🇷 Turkish (Language.TURKISH)
  • 🇬🇧 English (Language.ENGLISH)

⚠️ Error Handling

  • Missing files are marked as [Missing File]
  • Each error is reported in detail
  • Summary of process result is provided

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_importer-1.0.0.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

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

markdown_importer-1.0.0-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file markdown_importer-1.0.0.tar.gz.

File metadata

  • Download URL: markdown_importer-1.0.0.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for markdown_importer-1.0.0.tar.gz
Algorithm Hash digest
SHA256 c568a0d46b0d18659f6e84699e039504cf87c3261131df1241689d012617de46
MD5 302f5188f26e1a95d4c7126c40067645
BLAKE2b-256 5cf1161c69fa35e0f85a1c9cd381cbfc7a80b64e7b0384507fd8437ed8823c5c

See more details on using hashes here.

File details

Details for the file markdown_importer-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for markdown_importer-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dc243503f0f79b8396908c090e1a5d2bce1ac985cb0b6f0607da70a969305c60
MD5 79e0bbb5096f5423126604141d33a5b6
BLAKE2b-256 5127d9e5d2f553d4459fa4815876748e247a57143d32255ec58ffc03e3743a37

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