a_simple_static_site_generator
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
a_simple_static_site_generator [2021/03/15 08:25] – [Set up Header and Footer] add detail on header & footer files peteyboy | a_simple_static_site_generator [2023/02/23 20:13] – clean up text for clarity peteyboy | ||
---|---|---|---|
Line 11: | Line 11: | ||
> ssg is a static site generator written in shell. Optionally it converts Markdown files to HTML with lowdown(1) or Markdown.pl. | > ssg is a static site generator written in shell. Optionally it converts Markdown files to HTML with lowdown(1) or Markdown.pl. | ||
+ | (note: Markdown.pl is installed on SDF cluster as of this writing, so that's what it will use) | ||
==== How it Works ==== | ==== How it Works ==== | ||
Line 31: | Line 32: | ||
===== Clone Git Repo ===== | ===== Clone Git Repo ===== | ||
- | change dirs to a folder that you keep projects in ('' | + | change dirs to a folder that you keep projects in ('' |
$git clone https:// | $git clone https:// | ||
- | ===== Copy to your personal | + | ===== Copy to your personal |
* Make sure you have a ~/bin folder. | * Make sure you have a ~/bin folder. | ||
* copy the ssg5 executable file to the '' | * copy the ssg5 executable file to the '' | ||
Line 42: | Line 43: | ||
===== Set Up src and dest ===== | ===== Set Up src and dest ===== | ||
- | * You can create a source folder, named whatever, let's say '' | + | * You can create a source folder, named whatever, let's say '' |
* If you want to make sure things look right, you can make a destination folder that is not your '' | * If you want to make sure things look right, you can make a destination folder that is not your '' | ||
Line 48: | Line 49: | ||
If you want consistent headers or footers, just | If you want consistent headers or footers, just | ||
- | * If your site has or wants a favicon, put it as // | + | * If your site has or wants a favicon, put it as // |
- | * Put something you want at the beginning of each file (css, < | + | * Put something you want at the beginning of each file (css, < |
* At minimum, you want a HTML and title tag, the blank Title will get filled by H1 of your Markdown doc | * At minimum, you want a HTML and title tag, the blank Title will get filled by H1 of your Markdown doc | ||
* '' | * '' | ||
- | * Put something you want at the end of each file into '' | + | * Put something you want at the end of each file into '' |
* At minimum, you want closing /BODY and /HTML tag | * At minimum, you want closing /BODY and /HTML tag | ||
- | * '' | + | * '' |
- | * Exclude any paths in '' | + | * Exclude any paths in '' |
===== Put any existing HTML files into Source folder ===== | ===== Put any existing HTML files into Source folder ===== | ||
- | You can copy whatever you already have int '' | + | You can copy whatever you already have in '' |
===== Start Writing Markdown ===== | ===== Start Writing Markdown ===== | ||
- | Ah, the easy part! Just write your musings in any text editor using the [[ https:// | + | Ah, the easy part! Just write your musings in any text editor using the [[ https:// |
< | < | ||
Line 77: | Line 78: | ||
===== Running SSG5 ===== | ===== Running SSG5 ===== | ||
- | If you just run '' | + | If you just run '' |
$ ~/bin/ssg5 | $ ~/bin/ssg5 | ||
Line 84: | Line 85: | ||
Assuming you've added '' | Assuming you've added '' | ||
- | ssg5 ~/html_src | + | ssg5 ~/html_source |
- | I use '' | + | If you used the minimal '' |
- | '' | + | |
+ | < | ||
+ | < | ||
+ | < | ||
+ | ... | ||
+ | </ | ||
+ | |||
+ | |||
+ | I use the'' | ||
+ | '' | ||
**After you generate your site, run '' | **After you generate your site, run '' |
a_simple_static_site_generator.txt · Last modified: 2023/02/23 20:15 by peteyboy