Skip to main content

A command-line static site generator.

Project description

TextHTMLPress

A command-line static site generator to generate a complete HTML website from raw data and files (txt files or MarkDown files).

Features

  • Name: TextHTMLPress
  • Github Repo
  • MIT License
  • README.md
  • requirements.txt
  • title of .html file
  • customized output destination
  • CSS stylesheet
  • customized option from config file

Dependencies

This tool is written by Python 3.9, with pip 21.1.2.

Check the requirements.txt.

How To Use

  1. Download the code (the TextHTMLPress folder)
  2. Using a command line tool (CLI) such as Windows cmd, git bash, Unix shell or MaxOS Terminal.
  3. In the CLI:
# install requirements
pip install -r requirements.txt
# redirect into the package folder
cd ~/yourpath/TextHTMLPress

# check help
# it might be python3 __main__.py --help on your machine
# python3 instead of python

python __main__.py --help
# generate .html from a .txt file
python __main__.py -i ./tests/inputs/Silver\ Blaze.txt
# generate .html files from a folder 
python __main__.py -i ./tests/inputs/
# use multiple options
python __main__.py -i ./tests/inputs/Silver\ Blaze.txt -s https://cdn.jsdelivr.net/npm/water.css@2/out/water.css
# use config file
# or python __main__.py -c config.yml
# 
python __main__.py --config config.yml
# specify the lang attribute in root element of HTML, default en-CA
python __main__.py -i ./tests/inputs/ -l fr

Example Output

Please find here.

License

License: MIT

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

TextHTMLPress-1.0.1.tar.gz (2.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

TextHTMLPress-1.0.1-py3-none-any.whl (3.1 kB view details)

Uploaded Python 3

File details

Details for the file TextHTMLPress-1.0.1.tar.gz.

File metadata

  • Download URL: TextHTMLPress-1.0.1.tar.gz
  • Upload date:
  • Size: 2.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.1

File hashes

Hashes for TextHTMLPress-1.0.1.tar.gz
Algorithm Hash digest
SHA256 d06003515ee30a1705d4654f727ac4874d05c0ce45a0fdba94423d260789ac6d
MD5 cb3381aa09c5607efe884d9bebab743e
BLAKE2b-256 57d020d4394c756d3176390c9a392c3afa087bc376d9cb35b168a94339e25f02

See more details on using hashes here.

File details

Details for the file TextHTMLPress-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: TextHTMLPress-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 3.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.1

File hashes

Hashes for TextHTMLPress-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 30ccde08d9e196f0c751f32adba243f8ec6de184678ae78b40d0893f34353df8
MD5 3beb30e6b0e7b314ca37316d4aea0ed9
BLAKE2b-256 547ea576f11e1e57b63e7e1e94f45364a118662381e60619b4aeec1cfc39cfc7

See more details on using hashes here.

Supported by

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