cljs/api

ideas for jekyll site integration

shaunlebron opened this issue · 1 comments

The temporary pages generated by write.clj and templates/*.md have served well to plan out all the data and views required for these doc pages, but I think the desire to quickly shoe-horn this generator into creating the site's pages will hurt simplicity and ease of long term maintenance.

Thus, it may be best to have a task in this repo to hand over data rather than pages to the jekyll site directory to render by its own means. I think this will simplify website maintenance to restrict jekyll's input to be generated data rather than generated templates.

This repo will have a gen-site task, which will create:

  • json files in jekyll's _data directory, accessible from any template
  • docs/**.md files for index, history, namespace and symbol pages, containing:
    • front matter such as symbol or namespace names
    • content blocks for markdown content
  • symbol references file for simple cross-referencing of symbols

The jekyll repo will be responsible for maintaining:

  • _layout and _include template files controlling how the data is rendered

Moving this work to the site repo so that the only interface between the docs repo and site repo is the plain data file:

cljs/site#5