Skip to main content

Convert between markup languages

Project description

Build Status Code style: black

Txt2tags

Txt2tags is a document generator. It reads a text file with minimal markup such as **bold** and //italic// and converts it to the following formats:

  • AsciiDoc
  • Creole 1.0
  • DocBook
  • DokuWiki
  • Google Wiki
  • HTML
  • LaTeX
  • Lout
  • MagicPoint
  • MoinMoin
  • PmWiki
  • Plain Text
  • SGML
  • UNIX Manpage
  • Wikipedia/MediaWiki

You can use it as a command line program or in a Python application.

Installation

We recommend using pipx to install and run txt2tags in an isolated environment without affecting any system packages:

python3 -m pip install --user pipx
python3 -m pipx ensurepath
pipx install txt2tags
txt2tags --help

Of course you can also use pip to install txt2tags globally or in a virtual environment:

pip install -U txt2tags

Usage

Simple example for command line usage:

  1. Write a text file like this (leave 1st line blank):

    = Hello =
    I'm a robot. You're my **master**!
    [smile.jpg]
    
  2. Run this command:

    txt2tags --target html --no-headers file.t2t

  3. The result is:

    <H1>Hello</H1>
    <P>
    I'm a robot. You're my <B>master</B>!
    <IMG ALIGN="middle" SRC="smile.jpg" BORDER="0" ALT="">
    </P>
    

History

Aurelio Jargas started the development of Txt2tags in 2001. The program saw several releases from 2001 to 2010, the last of which was version 2.6. Afterwards, Aurelio became less involved in the development. Still, many new features were added in the main repository (https://github.com/txt2tags/txt2tags), but they were never officially released. In my opinion, many of the new features are only useful for a very small set of users. The extra code adds bloat to the program and makes it hard to maintain the code. Unfortunately, these concerns are not shared by the whole Txt2tags development team. Therefore, I decided to branch off version 2.6 and maintain a simpler txt2tags version that works on Python 3. The file TODO.md lists the goals for the project.

If you'd like to help out with any of the tasks, please get in touch. Pull requests are very welcome!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for txt2tags, version 3.4
Filename, size File type Python version Upload date Hashes
Filename, size txt2tags-3.4-py2.py3-none-any.whl (53.7 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size txt2tags-3.4.tar.gz (46.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page