Sunstone User Guide
okf_version
0.2
title
Sunstone User Guide

Sunstone User Guide

Sunstone is a markdown editor for git users. Point it at any folder of .md files and you get live preview, wikilinks, backlinks, full-text search and git review, with your files staying plain markdown on disk. It has first-class support for the Open Knowledge Format.

This guide is itself a Sunstone Bundle, served read-only by Sunstone Web. Everything you see here (the Explorer, search, backlinks, the outline) is the product showing itself.

Getting started

  • Getting started - Install Sunstone, open a folder, or run it in the browser without installing anything.

Writing

  • Editing - The editor: live preview, links, frontmatter, comments, footnotes, diagrams, images and PDF export.
  • Navigating - Finding your way around a Bundle: the Explorer, search, the outline, backlinks and the tiling workspace.

Collaboration and publishing

  • Git - Review your changes against git and step through a file's history.
  • Sunstone Web - Serve a Bundle in the browser, read-only or as a git-synced team wiki, and read it from scripts and agents.

Format and appearance