Home

Awesome

Scribble

Scribble is a NuGet package to do the heavy lifting of creating and maintaining documentation in your projects.

Check the docs folder for details about the concepts and ideas.

Specifically it is intended to:

Getting Started in 3 easy steps

As part of the installation, Scribble will create the folder structure under docs in your solution folder (or repository root if it detects a git/hg repository) and open the site in your default browser.

Scribble will also open the Markdown template for the index so you can start editing quickly

screenshot of docs folder

In the background Scribble will open a tiny webserver to transform the Markdown files and other files into a website which you can view immediately in the browser

screenshot of browser

When you open the solution after subsequent usages, the previewer will startup again so you can keep your documentation close.

Features

Markdown everywhere

Code Snippet detection