Neruda

What's for?

Sorry, your browser does not support SVG.

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

Features

  • Inherit all org mode features (tables, syntax highlighting, code blocks evaluation, multiple languages support…)
  • Do not require any emacs lisp knowledge
  • Do not require any server-side code, nor databases
  • Allow fine customization of generated html files
  • Switch easily between various themes
  • Native tags and ATOM feeds support

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.

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.

Written by Étienne Deparis with Emacs 26.2 (Org mode 9.2.4), and published with Neruda

Last modification on mercredi 31 of juillet, 2019 at 20:15

Validate