`beulogue` [\bøloɡ\]: french for blog. https://beulogue.ehret.me/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.
 
 
Siegfried Ehret efb3c2cc12 🔥 remove useless import 1 year ago
docs 📝 update docs 1 year ago
spec 🚀 init project ! 2 years ago
src 🔥 remove useless import 1 year ago
.editorconfig 🚀 init project ! 2 years ago
.gitignore 🔧 update gitignore 2 years ago
.travis.yml 🚀 init project ! 2 years ago
.upignore 🔧 setup up 2 years ago
CHANGELOG.md 📝 update changelog 1 year ago
CONTRIBUTING.md 🚀 init project ! 2 years ago
LICENSE 🚀 init project ! 2 years ago
Makefile 🔧 update makefile 1 year ago
README.md 📝 update readme 1 year ago
brrr.yaml 🎁 update brrr config 1 year ago
shard.lock 🎁 replace mustache with crinja for templating 1 year ago
shard.yml ⬆️ update version 1 year ago
up.json 🔧 fix lambda runtime 1 year ago

README.md

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:

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