Project

florby

0.0
No release in over a year
a static site generator for digital garden
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies
 Project Readme

Florby

Florby is a static site generator that converts Markdown files to HTML. It's specifically designed for Digital Gardens.

Features

  • Markdown to HTML conversion
  • Wiki-link notation support
  • Automatic sitemap generation
  • File change watching functionality
  • Development server

Installation

$ gem install florby

Or add to your Gemfile:

gem 'florby'

And then execute:

$ bundle install

Usage

Build

To generate HTML files from Markdown:

$ florby build

Server

To start the development server:

$ florby server

To start the development server with file watching (auto rebuild):

$ florby server --watch

Watch

To watch for file changes and automatically rebuild:

$ florby watch

Configuration

You can create a config.rb file in your project root as a configuration file.

host 'https://ukstudio.jp'

copy_from '/assets'
copy_from 'robots.txt'
copy_from 'CNAME'

License

See the LICENSE file.