Hello from the knowledgebase
A first article that proves the knowledgebase turns a markdown file into a page with headings, lists, links, and code.
This article exists to prove the knowledgebase works end to end. A markdown file in the repository became this page, with its own title, description, and social tags, and the sitemap lists it. The real guides replace it.
What an article is
An article is one markdown file. Its front matter names the title, the description, and the date, and the file name becomes the address: this file is hello-knowledgebase.md, so it lives at /kb/hello-knowledgebase.
What it can hold
- Headings from the second level down; the title is the first.
- Lists, links such as Repo Fleet, and
inline code. - Tables and fenced code blocks, which keep their own face and never take the labelling one.
| Front matter | Says |
|---|---|
title |
The heading and the browser tab |
description |
The summary under the title, and the meta tag |
date |
When it was published; the index lists newest first |
draft |
true keeps it out of the index and the sitemap |
A code block
name: Repo Fleet
on:
schedule:
- cron: "7,22,37,52 * * * *"
A draft article is reachable by its address but listed nowhere, so a piece can be checked in place before it is published.