{ "title": "CWIK" }


Cwik (pronounced ‘quick’) is an editable documentation web site (wiki) that is quite different from what has been done before:

  • All pages are stored in an enhanced Markdown format
  • Pages are stored in a source control system (git)
  • Edits are signed by cryptocurrency tokens
  • Integrated with source code documentation generators
  • Automatic pdf generation and enhanced markdown makes pages useable for document production.

Enhanced Markdown

Here are some examples:


Full Documentation
The Gamma function satisfying Γ(n)=(n1)!nN\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N is via the Euler integral
Γ(z)=0tz1etdt. \Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.


Full Documentation

paren type controls shape
Square Rect
Round Rect
Link text
;place special chars in quotes

Protocol (Sequence) diagram

Full Documentation

AliceBobJohnHello Bob, how are you?How about you John?I am good thanks!I am good thanks!Bob thinks a longlong time, so longthat the text doesnot fit on a row.Checking with John...Yes... John, how are you?AliceBobJohn

Git storage

Your changes accumulate in local storage on the server. Press the “commit” button (upper right) to commit all edits.

Look here: to see the backing repository.

Token Integration


Source Documentation Generation

To be implemented

This system is able to integrate multiple Git-hosted repositories. A typical configuration would be one documentation focused repository and multiple source repositories. These source repositories can provide inline documentation that is extracted via various documentation generators (subsequently called “codedoc”) and provide access to “raw” source code.

Linking between documentation and code/codedoc or codedoc to codedoc occurs via a special syntax that allows references to code blocks, is tolerant of some code reorganizations, and identifies and records broken links for human repair.

There is a processing step to convert these links to .md format. So the full source data preparation steps are:

doc generator
git source code
code doc
git doc files
Link resolver
Markdown files
broken link report
(markdown file)