Delightfully simple static site generator written in Swift
Swift CSS HTML Makefile Other
Switch branches/tags
Nothing to show
Clone or download
Permalink
Failed to load latest commit information.
Carthage/Checkouts
Resources/default-template
Scripts
Sources
Spelt.xcodeproj
Spelt.xcworkspace
Spelt
SpeltTests
Stencil @ a382e4c
.gitignore
.gitmodules
Cartfile
Cartfile.resolved Updated dependencies for Swift 3 and Xcode 8 Sep 26, 2016
LICENSE.md
Makefile
README.md
SpeltComponents.plist

README.md

Spelt GitHub license

Spelt is a blog-aware static site generator written in Swift. It was created for the Spelt Mac app.

Installation

Using the installer

Download and run the Spelt.pkg file for the latest release.

Building from source

In order to build Spelt you need to have Carthage and a recent version of Xcode installed. Keep in mind that the master branch contains the latest development version and may not always be stable.

  1. Clone the project: git clone --recursive https://github.com/njdehoog/Spelt.git
  2. Install dependencies: make bootstrap
  3. Build and install CLI: make install

Usage

Create a new site to get started using Spelt. Replace PATH with the name of your blog.

spelt new PATH

Local preview

Spelt can run a local webserver which displays a preview of your site. When auto-regeneration is enabled, your site will be regenerated whenever a file on your project directory is changed.

spelt preview

Building

When building your site, the generated files are placed in the _build folder in your project directory.

spelt build

Documentation

Documentation for Spelt can be found at docs.spelt.io. This documentation was originally written for the Spelt Mac app, but most of it applies to the CLI as well.

If you spot any errors in the documentation, please submit a pull request in the documentation repository.

Contributing

This project is still in the early stages of development, so any help would be appreciated. Please feel free to fork the project and submit a pull request.

License

Spelt is released under the MIT License.