Skip to content

Repository files navigation

Alan website

The homepage is special, all its contents are in the template.

Markdown

Markdown is converted using kramdown, which has a quick reference guide.

Jekyll

The site is built using Jekyll, for which there are guides and docs aplenty.

_data/dist/<platform version>/versions.json are copies of the published versions.json files; the versions repo writes them on release (publish.sh), do not edit them by hand. _data/versions.json is hand-managed: the platform version, its alan script, and the versions of the platform components (model, interface, project-build-environment). The documentation tables select their pages by front matter (origin, version) and are rendered once per type and version with jekyll-include-cache.

GitHub Pages builds and deploys every push to master.

Rendering all generated language documentation takes minutes. For a build in seconds while working on templates and styles, add the development override: bundle exec jekyll serve --config _config.yml,_config.dev.yml.

About

Website for the Alan platform

Resources

Stars

2 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages