ferron

Ferron is a fast and simple static website generator made with Lua.
Log | Files | Refs | Submodules | README | LICENSE

commit 7d40aca8d4900fade0c2213ce4030d5e90d307b1
parent c587bf623974b93cf03530ab85bfa01575bbf2e1
Author: Hugo Soucy <hugo.soucy@equisoft.com>
Date:   Sun, 20 Oct 2019 16:35:06 -0400

Modify documentation

Diffstat:
MREADME.md | 12++++++------
1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md @@ -37,9 +37,9 @@ instructions: * `./cornelius start` After that with your favorite texteditor or IDE edit the -`site-config.lua` to meet the needs of your web site: +`config.lua` to meet the needs of your web site: -* `emacs site-config.lua` +* `emacs config.lua` ### Architecture of a Ferron website @@ -66,10 +66,10 @@ After that with your favorite texteditor or IDE edit the ## Content -All the content of your site should be markdown (`*.md`) file and +All the content of your site must be markdown (`*.md`) file and belongs in the `content/` repository. That folder must contains at -least an `index.md` file and an `index.json`. JSON files are used for -the metadatas of the web pages. +least an `index.md` file and an `index.{lua, json}` (optional +now). Lua or JSON files are used for the metadatas of the web pages. ## Archetypes @@ -82,7 +82,7 @@ tree. * `./cornelius create` -If it is a success Ferron will output something like this : +If it is a success Ferron 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.`