# button-ssg

> A __Static Site Generator__(_SSG_) for __OSD600__

Latest version **1.0.3** (published 2022-11-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install button-ssg
pnpm add button-ssg
yarn add button-ssg
bun add button-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.3 |
| Published | 2022-11-23 |
| First published | 2022-11-20 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 728.9 KB |
| Known vulnerabilities | 0 (+5 in 3 direct dependencies) |
| Install scripts | no |
| Author | LostButton |
| Maintainers | lostbutton |

## Links

- npm: https://www.npmjs.com/package/button-ssg
- Repository: my-button-ssg
- npm.io page: https://npm.io/package/button-ssg

## Dependencies (6)

- [fs](https://npm.io/package/fs.md) 0.0.1-security
- [git](https://npm.io/package/git.md) ^0.1.5
- [yargs](https://npm.io/package/yargs.md) ^17.5.1
- [button-ssg](https://npm.io/package/button-ssg.md) ^1.0.0
- [markdown-it](https://npm.io/package/markdown-it.md) ^13.0.1
- [text-ssg-tool](https://npm.io/package/text-ssg-tool.md) ^1.0.0

## Recent versions

- 1.0.3 (latest) — 2022-11-23
- 1.0.2 — 2022-11-23
- 1.0.0 — 2022-11-20

## README

# my-button

A __Static Site Generator__(_SSG_) for __OSD600__

This repo introduces a __JavaScript__ program that convert __.txt file__ or __.md file__ into a __HTML file__
# Installation 
First install via:
`npm install`

check if yargs is installed and if not run the following in your terminal:
`npm i yargs`
# Commands
`node my-button.js --input  Convert a text file to HTML file.`
After installation of yargs. You can simply run the program by the command:

`node my-button.js -i "Silver Blaze.txt"` or `node my-button.js -i LICSENSE.md`
Which will generate a __HTML__ file for the __'Silver-Blaze.txt'__ file or __'Silver-Blaze.md'__ file into the __/dist__ folder.

__Or__

`node my-button.js -i .\Sherlock-Holmes-Selected-Stories\` 
Which will generate __HTML__ files for the __Sherlock-Holmes-Selected-Stories directory__ into the __/dist__ folder.

or if you are using macOS or UNIX use forward slashes
`node my-button.js -i ./Sherlock-Holmes-Selected-Stories/`


**NOTE:** HTML files markdown syntax will be bold

`node my-button.js -c ssg-config.json` Will read the input and language options from the specified config file.

 # Test Site
 https://my-button-ssg.vercel.app/ 
 # License
 [__MIT License__](https://choosealicense.com/licenses/mit/)

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