Skip to main content

A Markdown-like markup language interpreter

Project description

Markdown-like Markup Interpreter

Project goal

Initially the idea was to use Markdown for making ODT files which will be compilant with GOST 7.32-2017. But as things were going the goal expanded to making an ODT from markup file and a template directory.

Possibly this project can be used as a library for a web-service, but there is no info about such use.

Installation and use

Via git

Clone the repository:

git clone https://gitlab.com/Fe-Ti/matomeru-mi.git

Run install.sh script (on *BSD, *Linux and others):

./install.sh

If everything was left as default then running a command below creates a zip archive with ODT structure:

matomeru-mi -if <input file> -of <output file>

For example

matomeru-mi -if README.md -of README.odt

Via pip

Run:

python3 -m pip install --upgrade matomeru-mi

Then the package will be downloaded. The execution is simple:

python3 -m matomerumi -if <input file> -of <output file>

Syntax

Consult Syntax.md (or a page in project documentation).

Implemented stuff

  • Paragraphs, headings and code blocks (paragraphs with monospace font);
  • Basic picture handling support;
  • Creation of multilevel numbered and bulleted lists;
  • Basic page break support;
  • Support for relative and absolute paths.

Ideas

  • No temporal directory;
  • PIP package;
  • Title page support;
  • Styling Engine;
  • Documentation;
  • Escape characters support;
  • CI;
  • Spreadsheets in docs.

Documentation

For syntax reference consult: Syntax

Documentation for library: Main page

Copyright 2021 Fe-Ti

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

matomeru-mi-2022.6.22.tar.gz (18.5 kB view hashes)

Uploaded Source

Built Distribution

matomeru_mi-2022.6.22-py3-none-any.whl (21.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page