fakestache-ssg

[Archived] A static site generator in Bash 4.
Log | Files | Refs | Submodules | README

commit 91708357083013af6cdeeb2ced51a10aadbbbc70
parent 3512881fd03ba666cc004a8cd26b466862817b5c
Author: Hugo Soucy <hugo@soucy.cc>
Date:   Sun, 12 Mar 2017 21:21:11 -0400

Enhance the archetype section of the documentation.

Diffstat:
MREADME.md | 106++++++++++++++++++++++++++++++++++++++++++++++++-------------------------------
1 file changed, 64 insertions(+), 42 deletions(-)

diff --git a/README.md b/README.md @@ -6,7 +6,7 @@ Made with [Bash](https://www.gnu.org/software/bash/), [Pandoc](http://pandoc.org/) and [Mustache](http://mustache.github.io/). -*Documentation coming soon*. +*The documentation is a WIP*. ## Installation @@ -15,49 +15,14 @@ Made with [Bash](https://www.gnu.org/software/bash/), 2. `git submodule init` 3. `git submodule update` - -## Architecture of Fakestache SSG - -* `archetypes/` - * `note.md` -* `config/` - * `config` -* `content/` - * `index.md` -* `functions/` - * `build-pandoc-templates` - * `clean-content-folder` - * `create-feed` - * `create-html-pages` - * `create-html-sections` - * `get-archetypes` - * `get-pandoc-templates` - * `get-static-files` - * `move-html-to-publichtml` - * `parse_yaml` -* `lib/` - * `mo/` -* `public_html/` -* `static/` -* `templates` - * `mustache/` - * `partials/` - * `head.mustache` - * `feed/` - * `feed-entry.mustache` - * `feed.mustache` - * `default-index.inc.mustache` - * `default-index.mustache` - * `default.mustache` - * `index.mustache` - * `pandoc/` -* `.gitignore` -* `.gitmodules` -* `fakestache` - ## Usage -* `./fakestache` +* To simply build the web site: + * `./fakestache` +* To build the site in development mode: + * `./fakestache -d` +* You can force the complete reset of the web site before building it: + * `./fakestache -r` ### Content @@ -72,4 +37,61 @@ create a content through an archetype, the basic metadatas of your markdown file are prefilled and it is put in the right place of the content tree. +##### Create a content from an archetype + +1. The first argument is the name (whithout the `*.md` extension) of an existing archetype. +2. The second (and the last) argument is the title you want to give to your content. + +* `./fakestache nameofthearchetype "The title you want for your content"` + +So if i'm using the `sample.md` archetype to create a new content it will look like this : + +* `./fakestache sample "This is my first content made from an archetype"` + +If it is a success FakeStache will output something like this : + +* `- The file '/home/hs0ucy/Documents/fakestache-ssg/content/sample/2017/03/this-is-my-first-content-made-from-an-archetype.md' hab been created.` + +Now you can open the file you have created and start to write right away whithout the need of filling the metadatas. + ### Templates + + +<!-- ## Architecture of Fakestache SSG --> + +<!-- * `archetypes/` --> +<!-- * `note.md` --> +<!-- * `config/` --> +<!-- * `config` --> +<!-- * `content/` --> +<!-- * `index.md` --> +<!-- * `functions/` --> +<!-- * `build-pandoc-templates` --> +<!-- * `clean-content-folder` --> +<!-- * `create-feed` --> +<!-- * `create-html-pages` --> +<!-- * `create-html-sections` --> +<!-- * `get-archetypes` --> +<!-- * `get-pandoc-templates` --> +<!-- * `get-static-files` --> +<!-- * `move-html-to-publichtml` --> +<!-- * `parse_yaml` --> +<!-- * `lib/` --> +<!-- * `mo/` --> +<!-- * `public_html/` --> +<!-- * `static/` --> +<!-- * `templates` --> +<!-- * `mustache/` --> +<!-- * `partials/` --> +<!-- * `head.mustache` --> +<!-- * `feed/` --> +<!-- * `feed-entry.mustache` --> +<!-- * `feed.mustache` --> +<!-- * `default-index.inc.mustache` --> +<!-- * `default-index.mustache` --> +<!-- * `default.mustache` --> +<!-- * `index.mustache` --> +<!-- * `pandoc/` --> +<!-- * `.gitignore` --> +<!-- * `.gitmodules` --> +<!-- * `fakestache` -->