beulogue

beulogue [\bøloɡ]: french for blog.

Installation

Download binaries

• Linux: ✅
• MacOS: 🚧 (MacOS versions will always come later than the Linux one)
• Windows: ❌

Go to the release page !

Build from source

• Clone this repository.
• Install Crystal and Shards.
• Run make install then make.
• The beulogue binary will be in the bin/ folder.

Usage

Add beulogue to your PATH and run beulogue !

📝 The documentation is available at https://beulogue.ehret.me/

Here are the possible commands:

• beulogue or beulogue build to build the site.
• beulogue help to show the help.
• beulogue version to show the the version.

Possible flags:

• -dev or --development:
  • will use an empty base instead of the one given in the configuration file to make local navigation easier
  • will add markdown in the drafts/ folder
• -d or --debug: show some logs
• -h or --help: show help

Protip: a few starter kits are available on these mirrors:

• bitbucket
• codeberg
• github

Notes

beulogue is an experiment to discover the Crystal programming language, 2 years after playing with the same concept with Node.js.

beulogue aims to stay simple and provide the following for the first version:

• mardown files to html pages
• basic templating (pages)
• basic templating (list)
• markdown front-matter
• multilingual site
• rss
• cli, help & debug

And maybe at some point:

• tags (in front matter)
• shortcodes
• links between languages
• orphan pages
• tags (pages)
• drafts

And probably won't:

• pagination

And absolutely won't:

• livereload

Development

License

Licensed under the GPLv3 license.

Versioning

beulogue follows my own FibVer (Fibonacci Versioning):

• Basically, it follows Semantic Versioning.
• You have to use Fibonacci suite numbers when you bump the version.
• Until you bump a major version, don't reset patch. For a version, it gives an idea of how many features and bugfixes you made.

I'll spec that one day...

Contributing

Check the CONTRIBUTING.md document for some info.

1. Fork it (https://github.com/SiegfriedEhret/beulogue/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• Siegfried Ehret - creator and maintainer