Title: FarBox Doc
This is a template for http://doc.farbox.com, a site built by about
60 lines code (in Jade template syntax), but with lots of amazing features.
This template also means a
documentation generator, turns a directory into a powerful website to render your documents.
If you installed the APP from FarBox named
FarBox Editor, you can also export a directory into a PDF document, same contents to your website.
How to use?
- make sure you had an account in
farbox.com, which means installed a Dropbox APP named
- copy the
templatefolder into the site folder
<your site folder named in Domain format>(also a sub folder of FarBox).
- login into farbox.com, you will find the site you created.
- put your documents into the
- put a
docsdirectory to create homepage.
- make sure there must be some documents in the directories of
docs, otherwise, the navigation will be incomplete.
No Server Needed, Supports Custom Domains
This is a template for
FarBox.com which one will turn your directory in Dropbox into a powerful website, so no server needed.
You can simply create a site folder named a subdomain of
the-doc.farbox.com, and the domain will be visitable. Then go to
http://yourdomain.com/admin to discovery something.
This is a template with a little code, so, just modify it if you like.
By the way,
AutoReload, no extra tools needed except
FarBox Editor, your website will be live in realtime when you coding the template.
Every document need a position. you can use
1.23 document title.txt to give the this document a position of
The filename rule is working for a file or a directory.
You can also declare a position in the metadata of a document (or landing doc).
1.2 will be at the front of
If do not put a position for a document, it also works, but without nice order.
Before writing the content of a document, you can put
metadata first. The simplest way looks like below:
Title: Document Title Position: 1.2 Date: 2014-01-06 12:09
Supports YAML too, it looks like:
--- Title: Document Title Position: 1.2 Date: 2014-01-06 12:09 Tags: - Tag1 - Tag2 ---
Directory Landing Page
index.txt(/.md/.mk/.markdown) into a directory, then the directory will have it's own landing page.
We also call it
Supports Table of Contents
It should be declared in the metadata part.
toc: yes /* or */ toc: no
Auto Generated Navigation
The navigation is very smart.
docs will be the main cells, and the subfolders of subfolders will be the sub cells.
If you open the url of a document, and the document has a
table of contents, then the
table of contents will be injected into the navigation too.
If you open the url of a document, the Navigation will scroll to the item which one is selected.
If a directory (displayed in the navigation) has no lading doc in it, the url of this directory will be
- If a folder to be a sub menu, make sure there are some articles in it, except
- If a article to be a sub menu, just put it into the
- Supports Mathjax.
- Auto linebreaks, if do not need this feature, make sure your filename endswith '.mk'.
- Table and Footnote are extended.
```lang codes ```
codes highlighting with lines displayed
```lang:n codes ```
This feature is also supported by
FarBox too. But only two languages are usable: English and Chinese.
Document Change Logs
This is a amazing feature, you can visit
http://youdomain.com/service/sync_logs (make sure you are login), this page will show the logs of sync in
You will get some information like
which ip) a document was changed/deleted/created.
You can set users with password to visit your site, and a dig sort system base on your visitors of a site, .etc. All of these are from the features of