Gustavo Martinez SSG for OSD600
npm install gmot-ssg
npm i gmot-ssg
`
What it does?
$3
`
example.txt:
"I had called upon my friend, Mr. Sherlock Holmes, one day in the autumn
of last year, and found him in deep conversation with a very stout,
florid-faced, elderly gentleman, with fiery red hair. With an apology
for my intrusion, I was about to withdraw, when Holmes pulled me
abruptly into the room and closed the door behind me."
`
will become:
`
example.html
example
example
"I had called upon my friend, Mr. Sherlock Holmes, one day in the autumn
of last year, and found him in deep conversation with a very stout,
florid-faced, elderly gentleman, with fiery red hair. With an apology
for my intrusion, I was about to withdraw, when Holmes pulled me
abruptly into the room and closed the door behind me."
`
How do I use it?
`
To use this tool, you need to type in the CLI the following:
npx gmot-ssg -i -o `
By default, this tool will create a "dist" directory in its folder where the output will be.
What options does it have?
`
This tool has an
-s --stylesheet option, which will take your input stylesheet link and place it inside the HTML.
-o --output option, this option will place the output in your custom output directory.
-v --version option, will display the current version of the program.
-l --language option, will let you set the language for the HTML.
-h --help option, will display the usage, options, and examples.
-c --config option, will read the config JSON file for arguments instead of command line.
`
What optional features does it have?
`
and <h1> tags
<br /> -s -stylesheet for custom css links
<br /> -o --output for custom output paths
<br /> -l --language for custom HTML language, default is en-CA.
<br /> It also accepts mixed input, txt files, md files and directories.
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />
<br /><h1 class="text-2xl font-bold mt-6 mb-4">Additional support for md (markdown) files</h1>
<br />
<br />| MD File | HTML File | Webpage |
<br />| ------------------------------- | ------------------------------------------ | ----------------------------- |
<br />| </code><strong>Bold Text</strong><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> | </code><b>Bold Text</b><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> | <strong>Bold Text</strong> |
<br />| </code><em>Italic Text</em><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> | </code><i>Italic Text</i><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> | _Italic Text_ |
<br />| </code># H1 Heading<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> | </code><h1>H1 Heading</h1><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> | <h1>H1 Heading</h1> |
<br />| </code>## H2 Heading<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> | </code><h2>H2 Heading</h2><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> | <h2>H2 Heading</h2> |
<br />| </code><a href="https://github.com/" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">GitHub</a><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> | </code><a href="https://github.com/">GitHub</a><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> | <a href="https://github.com/" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">GitHub</a> |
<br />| </code>---<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> | </code><hr /><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"> | <hr /> |
<br />
<br /><h1 class="text-2xl font-bold mt-6 mb-4">For Example (md files):</h1>
<br />
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />README Excerpt
<br />
<br />
<br /><h1 class="text-2xl font-bold mt-6 mb-4"><a href="https://github.com/GMOTGIT/GMOT-SSG" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">GMOT-SSG</a></h1>
<br />
<br />OSD600 0.1 - SSG
<br />
<br /><h2 class="text-xl font-semibold mt-5 mb-3">SSG - Static Site Generator</h2>
<br />
<br /><h2 class="text-xl font-semibold mt-5 mb-3">What this tool does?</h2>
<br />
<br />This tool will receive a <strong>input txt file(files)</strong> or <strong>directory(directories)</strong> and transform it in an <em>HTML page(pages)</em>.
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br />
<br />will become:
<br />
<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">
<br /><!doctype html>
<br /><html lang="en">
<br /><head>
<br /> <meta charset="utf-8">
<br /> <title>README Excerpt
README Excerpt
GMOT-SSG
OSD600 0.1 - SSG
SSG - Static Site Generator
What this tool does?
This tool will receive a input txt file(files) or directory(directories) and transform it in an HTML page(pages).