Metadata-Version: 2.1
Name: mdit-py-i18n
Version: 0.1.0
Summary: Markdown i18n and l10n using markdown-it-py
Home-page: https://github.com/phunh/mdit-py-i18n
License: LGPL-2.1-or-later
Author: Phu Hung Nguyen
Author-email: phuhnguyen@outlook.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Internationalization
Classifier: Topic :: Software Development :: Libraries
Requires-Dist: Pygments (>=2.16.1,<3.0.0)
Requires-Dist: markdown-it-py[plugins] (>=3.0.0,<4.0.0)
Project-URL: Repository, https://github.com/phunh/mdit-py-i18n
Description-Content-Type: text/markdown

<!--
SPDX-FileCopyrightText: 2023 Phu Hung Nguyen <phuhnguyen@outlook.com>
SPDX-License-Identifier: CC-BY-SA-4.0
-->

# mdit-py-i18n

Markdown i18n and l10n using markdown-it-py.

CommonMark compliant. All core Markdown elements are supported, as well as
table, and definition list. Front matter handlers are left for users to
implement.

## Install

```bash
pip install mdit-py-i18n
```

## Notes

Some notes about how different elements are handled:
- Inlines: newlines and consecutive spaces are not kept;
- Content of each HTML block isn't parsed into finer tokens but processed
as a whole;
- Fenced code blocks: only `//` single comments are processed;

## Development

### Environment

- With Conda

```bash
conda env create -f environment.yml
conda activate mpi
poetry install
```

### Usage

#### Extraction
- Follow `I18NEntryProtocol` and `DomainExtractionProtocol`
- Subclass `RendererMarkdownI18N`

#### Generation
- Follow `DomainGenerationProtocol`
- Subclass `RendererMarkdownL10N`
