The GitHub Pages site is built by GitHub Pages' own Jekyll from docs/ on the
main branch. There is no build step to run: push, and GitHub builds it.
_layouts/default.htmlis the shared page shell, and_layouts/post.htmlwraps blog posts.index.html,learn.html,news.htmlandsource.htmlare the main pages. Each starts with front matter giving itstitle,descriptionand the nav item it marksactive.blog/index.htmllists the posts. Blog posts go in_posts/, namedYYYY-MM-DD-slug.md, with atitleand optionally asubtitleanddescriptionin their front matter. They're published atposts/YYYY-MM-DD-slug.html, andfeed.xmlis generated from them.- The posts marked
archive: trueare preserved from the early Facets site. They describe their original release period and should not be used as current installation or API guidance. assets/styles/site.cssis the stylesheet.atom.xmlis a small static release feed and is edited directly.
To preview the site with the same Jekyll and plugins GitHub Pages uses, make a
Gemfile somewhere outside the repository containing
gem 'github-pages', group: :jekyll_plugins and gem 'webrick', run
bundle install there, and then, from that directory:
bundle exec jekyll serve -s path/to/facets/docs -d /tmp/facets-siteThe site is then at http://localhost:4000/facets/.
The .page, .post, brite.yml and assets/layouts/ files are left from
the former Brite site for historical reference. _config.yml excludes them
from the build.