Skip to content
Multilingual Markdown Generator

 

Multilingual Markdown Generator

This package provides a command-line interface to manage multilingual contents and generate i18n markdown from a single base file.

Available in Bash, Zsh, and Windows PowerShell.

English | Français | 한국어 | 日本語

How It Works 💡

By managing only one Base file, we can reduce the number of errors caused by missing or mismatched translations. Additionally, thanks to editing in a single file, we can expect convenient translation with the auto-completion function of AI tools such as Copilot.

Markdown:

How It Works: Markdown

Jupyter Notebook:

How It Works: Jupyter Notebook

Features ✨

Supports the following features:

  • Markdown, Jupyter Notebook(.ipynb) as input formats
  • As-is, HTML, PDF as ouput formats
  • Command-line interface for Bash, Zsh, Windows PowerShell
  • Python API
  • Recursive traversal mode with -r option (As-is, HTML, PDF are all supported)
  • Batch processing mode with YAML file (Only As-is is supported)
  • IETF language tags
  • UTF-8 encoding
  • Automatic generation of table of contents with level and emoji options (Markdown and Jupyter Notebook are both supported)
  • Base file validation (Check the number of tags of each language)
  • Validation only mode for CI/CD (Disable file generation)

User Guide 📖

Getting Started

  1. Installation
  2. Quick Start with Examples
  3. Upgrade and Uninstall

Basic Usage (CLI)

  1. Create Base File
  2. Recursive Option
  3. HTML, PDF Output

Advanced Usage (CLI)

  1. Base File Validation
  2. Using Juptyer Notebook
  3. Batch Processing with YAML File

Programming Guide

  1. Python API
  2. API Usage Examples
  3. Advanced Reference

Miscellaneous

  1. Troubleshooting
  2. Contribution Guide
  3. Changelog
  4. License

Contributors 🤝

Made with contrib.rocks.

If you are interested in how to contribute, please refer to the contribution guide.