# reza-ssgapp

> This is a Simple CLI tool based on nodejs for generating html files from our text files.

Latest version **1.0.4** (published 2021-11-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install reza-ssgapp
pnpm add reza-ssgapp
yarn add reza-ssgapp
bun add reza-ssgapp
```

Provides the command `reza-ssg`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2021-11-27 |
| First published | 2021-11-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 651.3 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| Author | Reza Poursafa |
| Maintainers | reza9472 |

## Links

- npm: https://www.npmjs.com/package/reza-ssgapp
- Repository: https://github.com/Reza9472/StaticSiteGenerator/tree/main
- Homepage: https://github.com/Reza9472/StaticSiteGenerator/tree/main#README
- npm.io page: https://npm.io/package/reza-ssgapp

## Dependencies (2)

- [showdown](https://npm.io/package/showdown.md) ^1.9.1
- [commander](https://npm.io/package/commander.md) ^8.2.0

## Recent versions

- 1.0.4 (latest) — 2021-11-27
- 1.0.3 — 2021-11-27
- 1.0.2 — 2021-11-27
- 1.0.1 — 2021-11-26

## README

# StaticSiteGenerator

This is a Simple CLI tool based on nodejs for generating html files from our text files.

# Getting Started

* clone the repository

  ``` git clone https://github.com/Reza9472/StaticSiteGenerator.git ```
* Install dependencies
  
  ``` npm i ```

-------------

# Features

* Display version of the tool:
 
  ```reza-ssg --version```
* Display command instructions (help):

  ``` reza-ssg --help```
* Create an html file from a text or markdown file:

  ``` reza-ssg --index "Silver Blaze".txt ```
  ``` reza-ssg -i Silver.md ```

* Create html files from all the text or markdown files inside the 'text files' folder:

  ``` reza-ssg --index "text files" ```
* Add your options like input, output, stylesheet and lang to a JSON file and pass it to the program.

``` reza-ssg -c config1.json ```

# Unit Tests

* Run tests on the code to make sure the functions work

``` npm test ```
# Format the code

* Formatting the code using prettier:

 ``` npm run prettier ```

# Run the Linter

* Running the Linter on the project:

 ``` npm run eslint ```
# License
This project is licensed under the MIT license

# Author

Reza Poursafa

---
_Source: https://npm.io/package/reza-ssgapp · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._