https://github.com/cutwell/static-site-generator

Markdown -> HTML Python CLI tool
https://github.com/cutwell/static-site-generator

markdown-to-html python-cli static-site-generator

Last synced: 9 months ago
JSON representation

Markdown -> HTML Python CLI tool

• Host: GitHub
• URL: https://github.com/cutwell/static-site-generator
• Owner: Cutwell
• License: mit
• Created: 2024-02-10T17:57:58.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-03T21:54:26.000Z (over 1 year ago)
• Last Synced: 2025-01-29T11:28:09.060Z (11 months ago)
• Topics: markdown-to-html, python-cli, static-site-generator
• Language: Python
• Homepage: https://cutwell.github.io/static-site-generator/
• Size: 30.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          

#  Static Site Generator

 A CLI tool for converting Markdown to HTML.

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![PyPI](https://img.shields.io/pypi/v/static-site-gen)](https://pypi.org/project/static-site-gen/)

[![Demo of the Read Me template command line app. It shows the user running.](demo.gif)](https://raw.githubusercontent.com/Cutwell/static-site-generator/main/demo.gif)

## Install

```sh

pip install static-site-gen

```

## Usage

```sh

ssg [-h] [--help] [--safe] [--debug] [--run=] [--config=] [--ignore=<.ssgignore>]

```

|Flag|Description|

|:---:|:---:|

|`-h`, `--help`|Show this help message and exit (optional).|

|`--safe`|Don't overwrite existing files (optional).|

|`--run=`|Specify website root folder (required).|

|`--config=`|Default metadata configuration in YAML format (optional).|

|`--ignore=`|Filepath to list of newline separated file paths to skip (optional).|

|`--debug`|Enable debug logging (optional)|

## Docs

For further customisation and run instructions, see [here](./docs/index.md).

## Contributing

For information on how to set up your dev environment and contribute, see [here](.github/CONTRIBUTING.md).

## License

MIT