txt2tags  3.7
About: txt2tags is a document generator that reads a text file with minimal markup such as **bold** and //italic// and converts it to formats like AsciiDoc, DocBook, HTML, LaTeX, MediaWiki. MoinMoin, Plain Text, SGML or Unix Manpage. For Python 2,7, 3.5 or newer (some 2.x features removed).
  Fossies Dox: txt2tags-3.7.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

txt2tags Documentation

Some Fossies usage hints in advance:

  1. To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
  2. If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
  3. Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies
  4. txt2tags-3.7.tar.gz contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).
README.md

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
  • Markdown
  • 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!