# Tiny Docs
## What is Tiny Docs
Tiny Docs is a simple and lightweight (single file!) documentation template that allows you to write documentation in markdown and have it rendered as a static site
## Features
- 📄 **Single file** - Just one HTML file!
- 📝 **Markdown** - Write documentation in [markdown](?page=snarkdown)
- 📦 **Zero dependencies** - No need for a build step or package manager. (Although there are tools to make it even smaller)
- 🎨 **Customizable** - Change the CSS to fit your style
- 📱 **Responsive** - Works on all devices
- 🚀 **Fast** - Loads _extremely_ fast
## Use cases
- Personal documentation
- Project documentation
- Software documentation
- _Anything_ that needs documentation
I made this because I wanted a simple way to write documentation and have it in a single file. I hope you find it useful!
## How to use
> This project is still in development. Some features may not work as expected
1. Download the HTML file (or clone the repo)
1. Open the file in your text editor
1. Write and customize your documentatio
## Planned features
- [ ] 🔎 Search
- [ ] ~~📖 Table of contents~~ ✅
- [ ] 🌐 Full Offline support
- [ ] 🛠️ Import from GitHub Wiki
- [ ] 📝 (Web) Builder
- [ ] 📤 Export to PDF/Markdown/HTML
# It's powered by Snarkdown!
[Snarkdown](https://github.com/developit/snarkdown) is a dead simple 1kb
markdown parser that converts markdown to HTML.
## Example
## Snarkdown
*[Snarkdown](http://github.com/developit/snarkdown)* is __easy__ to `use`!
Here's an [**important** anchor link](#example).
Two newlines creates a line break.
Or, end a line with two spaces.
Just like that!
Code & Poetry
-------------
You can also indent
blocks to display
code or poetry.
Indented code/poetry blocks
can be hard-wrapped.
**Or, wrap your code in three backticks:**
```JavaScript
function codeBlocks() {
return 'Can be inserted';
}
```
### Block Quotes
> You can insert quotes by
> preceeding each line with `>`.
>
> Blockquotes can also contain line
> breaks.
## Lists
- Unordered
* Lists
+ Of mixed type
1. Ordered
2. Lists
4. Numbers are ignored
# About
This is the about page
# 404
The page you are looking for does not exist
[Go back to the home page](?page=index)