Ferron is a static site generator (SSG) crafted with Lua >= 5.3.
This documentation is a WIP.
- Make sure Lua 5.3 (or up), and Luarocks are installed on your machine.
git clone firstname.lastname@example.org:hs0ucy/Ferron.git && cd Ferron
git submodule update --init && git submodule update --recursive --remote
- The rest of the installation process is made with the Ferron CLI
(command-line interface) named
- So make sure the
corneliusfile have the right permissions to be execute has a script.
chmod a+x cornelius.
- After that
./cornelius install. The
installwill check if Luarocks is installed on your system and then install all the dependencies with it.
- If all went well, you are up and ready to create your site.
First you need to copy the default site and give it the name of the website you want to create... to do so just type this and follow the instructions:
After that with your favorite texteditor or IDE edit the
site-config.lua to meet the needs of your web site:
Architecture of a Ferron website
To simply build a web site:
To build a site in development mode:
./cornelius build --dev
All the content of your site should be markdown (
*.md) file and
belongs in the
content/ repository. That folder must contains at
index.md file and an
index.json. JSON files are used for
the metadatas of the web pages.
Archetypes are presets files for writing content faster. When you 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
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.
Now you can open the file you have created and start to write right away whithout the need of filling the metadatas.