Fast Static Site Generator - a tool for generating a complete HTML files from raw data like txt and markdown files.
Project description
Fast Static Site Generator
Fast Static Site Generator (Fast SSG) - a tool for generating a complete HTML files from raw data like txt and md files. This tool was made with Python language.
Prerequisites
- Python3
- BeautifulSoup4
Tool installation
To install the tool run the following command
pip install fast-ssg==1.0.1
Tool features
- CSS stylesheet support by specifying
--stylesheetors - Title parsing support for txt files. First line, indicates title followed by two blank lines. This will populate the
<title>...</title>and add<h1>...</h1>to the top of the<body>...</body>. - Title parsing support for md files. Line starting with the Markdown syntax # indicates the title. This will populate the
<title>...</title>and add<h1>...</h1>to the top of the<body>...</body>. - Header parsing support for md files. Lines starting with the Markdown syntax ## or ### will be parsed with
<h2>...</h2>and<h3>...</h3>tags respectively. - Italic syntax support for md files. Contents surrounded by Markdown Syntax *italics* will be parsed to html
<i>...</i>tags. - Bold syntax support for md files. Contents surrounded by Markdown Syntax **Bold** will be parsed to html
<b>...</b>tags. - Bold and Italic syntax support for md files. Contents surrounded by Markdown Syntax ***Bold Italcs *** will be parsed with both italic and bold html tags.
- Link syntax support for md files. Contents in Markdown Syntax [Link](url) will be parsed to html link tags with working links.
- <code> block support for md files. Content surround by Markdown Syntax `code content` will be parsed to html
<code>...</code> - Horizontal rule support for md files. The Markdown
---gets converted to an<hr>tag. - If users specifies a folder for the input, automatically generates an
index.html, which has relative links to each of the generated files.
Usage with shorthand flags
| Description | Command |
|---|---|
| Generate basic HTML file(s) | fast_ssg --input "relative path or absolute path to the file or folder" |
| Generate basic HTML file(s) with CSS stylesheet | fast_ssg --input "relative path or absolute path to the file or folder" --stylesheet "URL to CSS stylesheet" |
| New Feature: Support arguments passed with Config File | fast_ssg -c ./ssg-config.json |
| Help | fast_ssg --help |
| Get current version | fast_ssg --version |
Shorthand flags
| Flag | Shorthand version |
|---|---|
--input |
--i |
--help |
--h |
--version |
--v |
--stylesheet |
--s |
--config |
--c |
Markdown
Headers
# H1
## H2
## H3
Links
[Inline-style link](https://github.com)
Bold & Italic
**bold text**
**italic text**
***bold and italic text***
Code block
`var x = y + z`
Horizontal rule
---
| Markdown syntax | HTML equivalent |
|---|---|
| Header 1 | <h1>Test</h1> |
| Header 2 | <h2>Test</h2> |
| Header 3 | <h3>Test</h3> |
| Bold | <b>Test</b> |
| Italic | <i>Test</i> |
| Link | <a href='URL'>Test</a> |
| Code | <code>Code</code> |
| Horizontal rule | <hr> |
Live version & Project-package website
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
fast_ssg-1.0.1.tar.gz
(7.5 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fast_ssg-1.0.1.tar.gz.
File metadata
- Download URL: fast_ssg-1.0.1.tar.gz
- Upload date:
- Size: 7.5 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.7.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d4637ccc0c85db3f4f2f7d897810028a3250a0273b4adf5ce22a524c17b3b420
|
|
| MD5 |
6a35b21d1c4676c499af51e0b18d44e0
|
|
| BLAKE2b-256 |
5d9c062524cff21673efa1507e0c59b0a60887708476da759e416f181b33465e
|
File details
Details for the file fast_ssg-1.0.1-py3-none-any.whl.
File metadata
- Download URL: fast_ssg-1.0.1-py3-none-any.whl
- Upload date:
- Size: 9.0 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.7.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
07c41f07e896a59d082acd38d19481db52b2652cde6ceccceb66e2195c4eca10
|
|
| MD5 |
b8e089ef166042f76e5260d315e23901
|
|
| BLAKE2b-256 |
d409ed99111e157e2034b963f7096bc7e5b862c77cc7c36e1613b503d2beadd7
|
