Skip to content

ukstudio/florby

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published