Siteit
About
Siteit allows users to convert text files into .html pages. Presently, Siteit supports input files in .txt and .md formats.
Installation
npm install -g siteitFeatures
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** |
<strong>Some bold text<strong/> |
| " | __Some bold text__ |
<strong>Some bold text<strong/> |
| Italic text | *Some italic text* |
<em>Some italic text</em> |
| " | _Some italic text_ |
<em>Some italic text</em> |
| Deleted text | ~~Some deleted text~~ |
<del>Some italic text</del> |
| Marked text | ==Some marked text== |
<mark>Some italic text</mark> |
| Inline Code | `Some inline code` |
<code>Some inline code</code> |
| Horizontal rule | ___ |
<hr /> |
| " | *** |
<hr /> |
| Heading 1 | # Heading |
<h1>Heading</h1> |
Contributing
If you are interested in contributing code to Siteit, see our contribution guidelines here.