2 Installation & Setup

jdwije edited this page Sep 17, 2014 · 3 revisions

This is a primer on installing LEWT and setting up your basic config files

LEWT is written in ruby so before you can run it you will need Ruby & Ruby Gems installed. If you don't have these yet I recommend you get up and running using Ruby Version Manager [RVM], it handles install paths better than the default install and might save you some path hassles when running ruby gems from the command line.

GEM Install

Once your setup, o install LEWT as a GEM:

gem install lewt

Next check that LEWT's executable path was correctly set

lewt --version

Should output what version of LEWT you have installed.

Basic Config

All your config files and templates will be located in the path/to/lewt/lib/config directory. All your extensions will be located in the path/to/lewt/lib/extenions directory. Where LEWT installs to depends on your platform so check the gems documentation for where they are installed on your machine.

Configuration files are plain old YAML documents. You can open them up with any text editor to edit them to your taste. One of the more basic configs you will probably want to configure is where LEWT loads config & extensions from. You can do this by creating a .lewt_settings file in your home directory (this should be the home directory of the user you run ruby with). In this file we will add a directory pointer to our customer lewt stash so edit this file and input:

lewt_stash: /your/custom/directory/path/

Copy the settings .yml files and the templates/ folder from the default config directory to your new custom path and edit to your hearts content. Example markup is given in all of these files. You will also need to create an extensions directory in your new lewt stash.

Some default templates are given in the templates directory. These templates are for the Liquid Render extension, they correspond to the command names of the processors that ship with lewt. You can edit these as you like or create new ones - just remember to put them in this directory!

You should checkout the .rb classes in the extensions directory in an editor to get an idea for how to configure them in more detail. Most of the specific documentation is still stuck in the source code ^^

And that's it You should be good to go.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.