Skip to content

A command-line static site generator for generating a complete HTML web site from raw data and files.

License

Notifications You must be signed in to change notification settings

Qiwen-Yu/TextHTMLPress

Repository files navigation

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

About

A command-line static site generator for generating a complete HTML web site from raw data and files.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published