Project

tufte

0.0
No commit activity in last 3 years
No release in over 3 years
Blog/static site generator based on tufte-css
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

~> 1.6
~> 3.3
~> 1.10
 Project Readme

tufte

Gem Version Build Status Code Climate Test Coverage No Maintenance Intended

tufte is a minimal static site generator ideal for getting a blog running quickly with:

Note: this library is an unmaintained experiment. If you want an actual static site generator, I would recommend Jekyll.

Getting started

You'll need Ruby and Bundler installed first.

Make a new directory for your blog and cd to it:

mkdir blog/
cd blog/

Add a Gemfile for the current version of tufte (make sure to commit this along with your Gemfile.lock for reproducable builds).

echo 'source "https://rubygems.org"\n\ngem "tufte", "~> 1.0"' > Gemfile
bundle install

Add binstubs so you don't have to prefix commands with bundle exec:

bundle binstubs tufte

Initialize a new blog and create scaffold files in the current directory:

bin/tufte init

Generate HTML pages from the templates:

bin/tufte build

Run a local server to view your blog at http://localhost:9292 (this is a simple wrapper around rackup so you can pass any options you normally use for Rack such as -p 4000 to run on port 4000):

bin/tufte serve

At this point you can edit the files in templates/ and posts/ to your liking, running bin/tufte build after each change until you are satisfied with your new blog.