Module: WaxTasks
- Defined in:
- lib/wax_tasks.rb,
lib/wax_tasks/error.rb,
lib/wax_tasks/utils.rb,
lib/wax_tasks/branch.rb,
lib/wax_tasks/collection.rb,
lib/wax_tasks/lunr_index.rb,
lib/wax_tasks/task_runner.rb,
lib/wax_tasks/iiif_collection.rb,
lib/wax_tasks/lunr_collection.rb,
lib/wax_tasks/pagemaster_collection.rb
Overview
The WaxTasks module powers the Rake tasks in ‘./tasks`, including:
- wax:pagemaster
-
generate collection md pages from csv, json, or yaml file
- wax:lunr
-
build lunr search index (with default UI if UI=true)
- wax:iiif
-
generate iiif derivatives from local image files
- wax:jspackage
-
write a simple package.json for monitoring js dependencies
- wax:push
-
push compiled Jekyll site to git branch
- wax:test
-
run htmlproofer, rspec if .rspec file exists
Tasks are run by a WaxTasks::TaskRunner object which is resposible for reading in site config from ‘_config.yml`
Defined Under Namespace
Modules: Error, Utils Classes: Branch, Collection, IiifCollection, LocalBranch, LunrCollection, LunrIndex, PagemasterCollection, TaskRunner, TravisBranch
Constant Summary collapse
- DEFAULT_CONFIG =
Returns The path to load Jekyll site config.
'_config.yml'.freeze
- LUNR_INDEX_PATH =
Returns The path to write WaxTasks::LunrIndex.
'js/lunr_index.json'.freeze
- LUNR_UI_PATH =
Returns The path to write default LunrUI.
'js/lunr_ui.js'.freeze
- SITE_DIR =
Returns The path to the compiled Jekyll site.
'./_site'.freeze