_config.yml

An archaeological excursion into the depths of available configuration.

You may have heard we have a lot of sites running the same theme. How? Well, because we put a bunch of junk into the config, that’s how! Neat. If you discover some new config options please add them here.

title

This is appended to the <title> of every page in the docs, so it will be something like _config.yml | Docs docs. It’s also used at the top of the sidebar.

versions

TODO: Document this. Used in Meteor docs/guide.

Example:

This is what organizes all the pages into a sidebar. The top-level keys are the categories, allowing you to group pages into thematic categories.

The keys inside are the filenames, without .md. So for example, if you have a source/formatting.md, you should just put formatting. You can also use subdirectories, like basics/queries.

Recently we added a feature that allows the sidebar to link to other sites entirely by specifying a title and href:

Social / APIs

Use these to add various buttons/integrations/social stuff.

GitHub

This is used to power the “Edit on GitHub” buttons on the pages. The repo is used to construct the GitHub URL, and the content root is when you have the content in a nested directory.

Used for Tweets to identify us as the owner of the page.

Slack

Adds a “Discuss on Slack” button to the pages with this URL.

Source directory

TODO document this

Unused / broken

Please fix these, or remove them if you see them in a config file.

subtitle

It’s only used in the placeholder text in the search field.

Totally unused.