aboutsummaryrefslogtreecommitdiffstats

What's for?

Neruda is a static website generator made for Org files. It improves the default Org HTML exporting/publishing routine.

Features

  • Inherits all Org mode features (tables, syntax highlighting, code blocks evaluation, multiple languages support…)
  • Does not require any emacs lisp knowledge
  • Does not require any server-side code, nor databases, only a simple http server like apache, nginx, lighttpd, hiawatha…
  • Allows fine customization of generated html files
  • Allows multiple sources for your Org file and let you organize them as you wish in the destination folder
  • Can use different theme for different sources
  • Supports tags and ATOM feeds

How to install it

Neruda is a Ruby gem. You need a working Ruby environment to use it. We recommand you to use RVM and a specific gemset. However it will works with a global ruby installation too.

Installation procedure with RVM
rvm get latest
rvm use ruby-2.6.3@neruda --create
gem install neruda

Now, you're ready to create your first Neruda website.

pablo init -t "My first neruda website"

Going further

All the Neruda configuration is stored in one YAML file named config.yml and stored at the root of your project. If none exists, a default one will be created the first time you run any pablo command.

You should read the config file documentation to discover its various options.