documentation for the markdown preamble?

[drobert]

Extremely new to slate and widdershins but I've been using a combination of swagger/openapi -> widdershins -> slate to get some documentation going.

Widdershins outputs a mardown file that includes this section:

---
title: My App
language_tabs:
  - shell: Shell
  - http: HTTP
  // others included as well
toc_footers: []
includes: []
search: true
highlight_theme: darkula
headingLevel: 2
---

I'm curious ... what is this? It seems important (and used by) slate but it's not referenced in the markdown syntax wiki page and I can't find any documentation on what this is or how it's used by slate.

Update: as I write this, I realize this may be an artifact of Widdershins and its history of working with 'shins' rather than slate. Perhaps this isn't used at all by Slate and I'm just flat out wrong. Apologies if this is the case.

[MikeRalphson]

This preamble is the "YAML front-matter" of the markdown input and controls various Slate features (Shins used a superset of this syntax). The individual keywords are documented in the Wiki in pages such as https://github.com/slatedocs/slate/wiki/Customizing-the-Language-Tabs, but not all in one place (partly to avoid duplication).

Slate's default index.html.md includes the following to get you started, and it should be relatively clear which aspects of Slate they customise:

---
title: API Reference

language_tabs: # must be one of https://git.io/vQNgJ
  - shell
  - ruby
  - python
  - javascript

toc_footers:
  - <a href='#'>Sign Up for a Developer Key</a>
  - <a href='https://github.com/slatedocs/slate'>Documentation Powered by Slate</a>

includes:
  - errors

search: true

code_clipboard: true
---