README.md 1.8 KB

Amber documentation

The source of https://docs.amber-lang.net, the documentation site of Amber Smalltalk. The site is built by Jekyll from the gh-pages branch of lolg.it/amber/amber-documentation. A push to that branch rebuilds and deploys it, through the pipeline in .drone.yml.

The pages

Every page is a Markdown file in the root of the repository, with front matter that places it:

layout: default
title: Working in Helios
nav_order: 3
permalink: /helios/
description: One sentence, shown in the list on the start page.

The navigation, the pager at the foot of a page and the list on the start page are built from nav_order, so a new page needs nothing else. The versions the pages describe are in _config.yml: amber_version moves with Amber's releases, and domite_version, silk_version and mini_mvp_version with those of the three libraries.

A page that moves keeps its old URL alive through a stub in moved/, with layout: redirect and the new URL in redirect_to.

Pages are worded as writing-style.md says, and every command and claim is run on a project made by amber init before it is written down.

Building the site

With Ruby and Jekyll installed, jekyll serve builds the site and serves it at http://localhost:4000, rebuilding on every save. Without Ruby, the image the pipeline uses does the same:

docker run --rm -v "$PWD:/srv/jekyll:ro" -v "$PWD/_site:/out" jekyll/minimal jekyll build -d /out

Contributing

Fork amber/amber-documentation on https://lolg.it, make a branch, edit, and open a pull request. The start page names the chat and the mailing list for questions.

License

The text and the code of this site are under the MIT License, see LICENSE.