Socket
Socket
Sign inDemoInstall

fast-ssg

Package Overview
Dependencies
1
Maintainers
1
Alerts
File Explorer

Install Socket

Detect and block malicious and high-risk dependencies

Install

    fast-ssg

Fast Static Site Generator - a tool for generating a complete HTML files from raw data like txt and markdown files.


Maintainers
1

Readme

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 --stylesheet or s
  • 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

DescriptionCommand
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 stylesheetfast_ssg --input "relative path or absolute path to the file or folder" --stylesheet "URL to CSS stylesheet"
New Feature: Support arguments passed with Config Filefast_ssg -c ./ssg-config.json
Helpfast_ssg --help
Get current versionfast_ssg --version

Shorthand flags

FlagShorthand version
--input--i
--help--h
--version--v
--stylesheet--s
--config--c

Markdown

Headers

# H1
## H2
## H3
[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 syntaxHTML 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

https://abatomunkuev.github.io/static_site_generator/

FAQs


Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc