Skip to content

vkczyz/silkmason

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

99 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SilkMason

A simple static site generator based on pandoc

  • FeedMason is an auxiliary script that generates Atom feeds for an existing website.
  • TagMason is an auxiliary script that generates tag navigation for an existing website using file metadata.

Usage

SilkMason will look for a config.toml file in its directory. A default configuration has been provided, which you can use by copying the example file in this repository:

$ cp config-example.toml config.toml

Once a configuration file exists, you can just run the executable:

$ ./silkmason.rb

Source and destination directories can be overridden with command-line arguments:

$ ./silkmason.rb $INPUTDIR $OUTPUTDIR

Configuration

  • input_dir string: the input directory
  • output_dir string: the output directory
  • template string: pandoc template to use for generated pages
  • filters array:string: Lua pandoc filters to run when generating pages
  • pandoc_args array:string: arguments to use when calling pandoc

  • feedmason.domain string: the domain used to identify the website
  • feedmason.author string: the owner of the website
  • feedmason.root string: the directory where the website is located (usually the same as output_dir)
  • feedmason.feeds array:string: directories, relative to feedmason.root, for which feeds should be generated

  • tagmason.root string: the directory where the website is located (usually the same as output_dir)
  • tagmason.filters array:string: Lua pandoc filters to run when generating tag index pages

Dependencies

  • pandoc
  • toml
  • nokogiri (FeedMason)
  • lua-toml (filters)
  • imagemagick (filters)

About

A simple static site generator based on pandoc

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published