CareerChive

Examples on this page will render with the proper styling within documentation.

Docs Reference

Docs Reference

Examples on this page will render with the proper styling within documentation.

To render only the documentation for previewing:

npm run docs

YAML Frontmatter

---
subtitle: Set an optional subtitle
search: false # Hide page from docs search

# h1 sets the page title and browser tab
---

Single-Sourcing

Shared prose lives in _snippets/. Import a snippet to use it on a page:

import Example from "../_snippets/example.mdx"

<Example />

Leave YAML and # h1 on the host page. Snippet ## / ### headings are included in the host table of contents automatically, in the order the snippet appears on the page.

Content

Headings

The table of contents is built from ## and ### headings.

Callouts

Text & Links

You can write bold and italic in the same sentence as the surrounding copy, and add links as usual.

Append {.button} to a markdown link for a bordered button. Append {.blank} to open a link in a new tab.

Drop {.lock} or {.gear} anywhere in prose: / .

Button

List Items

  • one
  • two
  • checked items
  • unchecked items
  1. first
  2. second

Code

Highlighting works for yaml, bash, typescript, and markdown.

export const title: string = "CareerChive";

# install dependencies
npm install
npm run dev

Layouts

Tabsets

::: {tabset} ::: splits on # h1 headings. Those headings become tab labels, not page titles.

Columns

::: {.columns} ::: have gaps between them by default, and no margin or padding on the sides:

A 25/75 mobile-responsive flexbox column example.

To add spacing on the top-level fence:

::: {.columns .pa2 .ma2}
::: {.columns .pl2 .mt2}

Tables

Pipe tables use a header row, a | --- | separator, and body rows:

DataWhoPurpose
Organization name and date rangeAnyone with the archiveGroup daily entries
Daily attendance, work, notes, and ratingsThe person loggingTrack that day's record
Search queries and ChiveBot summariesThe person searchingFind and recap logged days

Align a column with :--- (left), :---: (center), or ---: (right) in the separator row.