Skip to content

eduardosasso/leter

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Leter

GitHub license Build Status Coverage Status Maintainability

A code-free, minimalist thus modern static site generator for the idealistic.

Overview

The motivation to build Leter came from the desire to have a clean and beautiful personal website + blog that was fast, mobile, and SEO friendly, fully automated with smart defaults and required zero code or learning curve.

Features

  • Zero coding
  • Fully automated
  • Beautiful themes
  • SEO optimized
  • Mobile friendly
  • Google analytics
  • Syntax highlight
  • Permalinks
  • Smart defaults
  • Index page for blogs
  • Support for Github Markdown

Installation

brew install leter

Usage

$ leter --help
Usage: leter [options]
    -n, --new                        Setup leter.yml file
    -b, --build                      Build website
    -c, --clean                      Clean
    -h, --help                       Show this help message
    -v, --version                    Show Leter version

Getting Started

After installing Leter go to the root folder of your project in the terminal and run:

leter --new 

This will create a file called leter.yml with the following options:

theme: default
date_format: "<%= Leter::DATE_FORMAT %>"

google_analytics:

Customize your website by editing this file, disable features you don't need by either removing the key or removing its value.

Work on your content by creating markdown files like the example below:

.
├── blog
│   ├── being_productive.md
│   ├── consistency.md
│   ├── first_post.md
│   └── leter_is_awesome.md
├── index.md
├── leter.yml
└── resume.md

To build your website into HTML run:

leter --build

Leter creates the HTML alongside your markdown files, and the final structure of your site will look similar to this:

.
├── blog
│   ├── being-productive
│   │   └── index.html
│   ├── being_productive.md
│   ├── consistency
│   │   └── index.html
│   ├── consistency.md
│   ├── first-post
│   │   └── index.html
│   ├── first_post.md
│   ├── index.html
│   ├── leter-is-awesome
│   │   └── index.html
│   └── leter_is_awesome.md
├── index.html
├── index.md
├── leter.yml
├── resume
│   └── index.html
└── resume.md

Markdown files like blog/first_post.md are translated into blog/first-post/index.html so you can get clean and SEO friendly URL's. Also, note under blog the file index.html is a listing page with links for all the posts in that folder.

To safely remove and clean all the HTML and assets generated by Leter run:

leter --clean

Showcase

TODO

About

A code-free, minimalist thus modern static site generator for the idealistic. ➪

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published