Statyk is a versatile static site generator.
Go to file
Yann Esposito (Yogsototh) 87385bda86
Improve readme
2024-01-20 00:08:31 +01:00
resources/statyk Improve readme 2024-01-20 00:08:31 +01:00
.gitignore added resources 2024-01-16 09:02:07 +01:00
deps.edn Small logging improvement 2024-01-18 18:09:01 +01:00
README.org Improve readme 2024-01-20 00:08:31 +01:00
statyk Improve readme 2024-01-20 00:08:31 +01:00

Readme

statyk

A short program whose goal is to build a static websites as naturally as possible.

The main concept is about keeping in sync a directory of files and their respective content.

Mainly we would like the following:

For every file in _src directory create an associated generated file in _site.

For example:

_src/             ------------>  _site/
  index.md        -- pandoc -->     index.html
  about.org       -- pandoc -->     about.html
  yolo.html       ---- cp ---->     yolo.html
  post/01.md      -- pandoc -->     post/01.html
  post/02.org     -- pandoc -->     post/02.html
  img/logo.png    - imgoptim ->     img/logo.webp
  css/main.sass   - less+min ->     css/main.css
  js/main.js      - minimize ->     js/main.js

Another mechanism is building meta files.

phase 1:
  _src/             ------------>  _site/
    ...
    post/01.md      -- pandoc -->     post/01.html
    post/02.org     -- pandoc -->     post/02.html
    ..
    post/42.org     -- pandoc -->     post/42.html

phase 2:
  _site/             \    _site/
    index.md          |     ...
    post/01.html      |     sitemap.html
    ...                >    rss.xml
    post/20.html      |     archive.html
    ...               |
    post/42.html     /