Siteit


About

Siteit allows users to convert text files into .html pages. Presently, Siteit supports input files in .txt and .md formats.

Installation

``bash
npm install -g siteit
`

Features

Siteit comes with its built-in stylesheet and supports various screen resolutions. When a folder with .txt or .md files is supplied,
an Index file is also generated in the dist folder, linking to all generated files.

Usage


| Command | Option/Flag | Additional Argument(s) | Description |
| :-----: | :---------------------: | :----------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| siteit | -v or --version | n/a | Displays tool name and version information |
| siteit | -h or --help | n/a | Display usage manual |
| siteit | -i or --input | _./filename.(txt or md)_ | Converts the file's content supplied as an additional argument into a .html document. To locate the generated file, cd into the application's dist directory |
| siteit | -i or --input | _./directory_ | Converts all the files within a directory supplied as additional argument into .html documents. To locate the generated files, cd into the application's dist directory and open index.html |

Usage format: siteit [option/flag] _[additional arguments]_

Markdown files handling

Siteit fully supports the following markdown features:

| name | syntax | output |
| --------------- | ------------ | -------------------- |
| Bold text | Some bold Text | Some bold text |
| " | __Some bold text__ | Some bold text |
| Italic text | Some italic text | Some italic text |
| " | _Some italic text_ | Some italic text |
| Deleted text | ~~Some deleted text~~ | Some italic text |
| Marked text | ==Some marked text== | Some italic text |
| Inline Code | Some inline code | Some inline code |
| Horizontal rule | ___ |

---

|
| " | * |

---

|
| Heading 1 | # Heading |

Heading

` |

---

Contributing

If you are interested in contributing code to Siteit, see our contribution guidelines here.