Open Knowledge CLI Documentation
Frontmatter6 fields
Trust
UnverifiedDefault
Status
StableDefault
Sources 1
  1. CommonMark helpmarkdown-reference
type
Example
title
Markdown Viewer Showcase
description
Supported Markdown blocks and nested viewer rendering cases.
timestamp
sources
  1. 1
    id
    markdown-reference
    title
    CommonMark help

Markdown Viewer Showcase

Open this page with okn view Wiki. Use it as a visual regression fixture for the Markdown syntax that the Open Knowledge viewer supports.

This page is not a complete CommonMark or GFM compliance suite. The final section identifies standard syntax that the current viewer does not support.

Inline content

This paragraph has bold text, emphasized text, inline code, an internal link, and an external link.

Use the explicit anchor to test same-page navigation.

Viewer asset route

The image uses a path relative to this Markdown file. The local viewer serves it from the bundle. The HTML exporter copies it when publish.assets allows it.

Linked image preview

The linked image must render as an image. Selecting it must open the linked Markdown page.

Heading levels

Level three

Level four

Level five
Level six

Each heading level must remain visible and distinct.

Lists

  • Unordered item with strong text.
  • Unordered item with a local asset. This continuation belongs to the same list item.
  1. First ordered item.
  2. Second ordered item with inline code.

Blockquote with nested content

A blockquote can contain inline formatting.

  • This list is inside the blockquote.
  • This item contains an internal link.

Table with links and images

AlignmentPreviewReference
LeftRoute thumbnailAsset page
Leftinline code and bold textViewer examples

The image must stay inside its table cell. The links must keep their resolved viewer routes.

Code blocks

package main

import "fmt"

func main() {
	fmt.Println("Markdown viewer")
}
flowchart LR
  Markdown --> Viewer
  Viewer --> Asset

Source footnote

This source footnote opens the matching structured source entry.markdown-reference

Comments and agent context

Explicit anchor target

The same-page link targets the explicit anchor above this heading.

Standard syntax outside the current viewer contract

The current renderer does not interpret these constructs. Keep them inside a code block when this fixture documents the current behavior.

Setext heading
==============

- [ ] GFM task item
~~GFM strikethrough~~

[Reference-style link][target]
[target]: viewer-assets.md

    Indented code block
Powered by OpenKnowledge.sh