Farbox Editor

　　Farbox Editor是一款新型的支持Markdown语法的编辑器，除了最终Markdown渲染后的代码快支持高亮外，Editor还只是在书写的过程中，对代码块的实时高亮；代码块需要三个反引号包裹，并且在第一个反引号后面声明代码类型；FarBox 就是为此而设计的，可以通过预设的几个问题，在每天定期的时候弹出提醒，通过自问自答的方式，来记录从我们身上流过的时光；支持自定义预览的HTML内容，在FarBox程序所在目录，有个resource/template的文件夹，里面的post.html，style.css按需自定义即可（最好先行备份）。强大又实用，需要的用户可以下载体验

软件功能

　　Editor PDF 导出的特别支持

　　支持封面设定

　　支持自动生成目录

　　支持表格（Markdown语法）

　　支持代码高亮（Markdown语法）

　　支持脚注（Markdown语法）

　　支持图片

　　如果图片不是本地的，Editor也会先从互联网获取后再渲染

　　PDF导出的各项设置

　　封面：如果设置了的话，PDF的第一页会是所设定的图片。一般需要保持A4纸的宽高尺寸，为1:1.4143。

　　标题：如果有设置，会在内容开始的第一页居中显示，也可以为空。

　　二级标题：如果有设置，并且在有标题的前提下，会紧随大标题，作为补充。

　　缩进： 默认（行首）不缩进。缩进和不缩进的PDF渲染逻辑不完全一致，所以结果会有些许差异（主要体现在行间距上）；一般情况下，纯文字没有什么特殊格式情况下，缩进2个字是可以考虑的，反之则不建议。

　　文档排序：自然排序是指Editor内各自默认的排序，时间的正、倒序，则是按照文章的发表时间作为依据排列的。

　　文档拼接：决定了两个文档之间需要不需要分页。

软件特色

　　文章的TOC视图

　　TOC即Tables of Contents，在Markdown语法中，可以用# head 1 ## head 2来声明几级标题，与此同时，全文会形成一个纲要，即是TOC。

　　TOC在不同的场景下，表现会不一样。在Editor中，则有一个专门的管理区可以提取TOC，这会让你在写作的过程中，如果有很强条理性的要求下，可以帮你更容易看到全文的脉络。

　　TOC管理区的开启、关闭，可以在底部菜单栏中控制，也可以使用快捷方式Ctrl+T（Mac版为Command+T）。

　　Markdown的复制、粘贴

　　当你从网页中复制内容，粘贴到Editor的时候，会自动转化为Markdown格式。

　　你也可以直接点击鼠标右键，复制得到已经转为HTML格式的内容，这样在发邮件的时候，直接粘贴就变得非常高效。

　　当然啦，你也可以选择直接复制HTML源码到粘贴板。

　　Markdown预览直接作为邮件内容

　　在Markdown预览窗口中，点击右键，你就会找到自己需要的操作命令（复制(富文本)）。之后，Markdown解析后的内容就会在你的粘贴板中，粘贴到邮件的正文内容内即可。

　　一般来说，这是支持代码高亮、数学公式的最终显示效果的；但实际上，也取决于收件人所用的邮件提供商，以及当前浏览邮件的App（或浏览器）。

　　Markdown预览直接作为微信公众号的图文消息

　　同Markdown预览直接作为邮件内容，将复制后的内容，粘贴到微信公众号的后台编辑器内即可。

　　如果有图片的话，请务必在FarBox对应的网站后台，设置当前网站允许外链。 这样，内容里的图片，才会自动被添加到文章中。

　　注意：微信的图文消息编辑中，会自动将文章中的图片上传到微信的服务器上；所以，使用这个命令的时候，Editor会有个请求过程，图片数量越多，等待时间会长一些。另外，最终微信的图文消息编辑中，可能提示图片粘贴失败，可能需要重试，即可。

安装步骤

　　1、用户只要点击本网站提供的下载地址即可将应用程序下载到磁盘

　　2、打开数据包，解压数据文件，得到可以直接使用的程序文件，双击应用程序即可安装，点击是按钮

　　3、用户可以根据自己的需要点击浏览按钮将应用程序的安装路径进行更改

　　4、快捷键选择可以根据自己的需要进行选择，也可以选择不创建

　　5、现在准备安装主程序。点击“安装”按钮开始安装或点击“上一步”按钮重新输入安装信息

　　6、等待应用程序安装进度条加载完成即可，需要等待一小会儿

　　7、根据提示点击安装，弹出程序安装完成界面，点击完成按钮即可

使用说明

　　目录（TOC）说明

　　文档作为一级，其内部次级标题作为二级： 这是文件夹导出为PDF的默认选项，表示每篇文章的标题所第一级索引，而文章内的各个二级标题（如果有的话）会作为二级索引。

　　分类作为一级，文档作为二级： 这表示分类目录（Category）会作为第一级索引，而每一篇文章的标题，则作为二级索引。

　　仅文档一级： 索引仅一级，显示的是各个文章的标题。

　　仅分类一级：索引仅一级，显示的是各个分类目录（Cateogry）

　　一级（单文档导出）：仅针对单文档导出为PDF时候的选项，表示索引仅仅一级。

　　二级（单文档导出）：仅针对单文档导出为PDF时候的选项，表示索引会有两级。比如说如果第一级是H1，那么二级标题就会从H2来。

　　不使用目录：表示导出的PDF不创建TOC相关的索引，另外，在这种情况下，每页的PDF底部，也不会特别标明页码。

　　PDF导出小贴士

　　特别注意：当文章中，包含外部链接图片的时候，并不适用（文件夹）PDF的导出；外链数越多，程序崩溃的概率越高。

　　自定义排序：修改文件夹、文档的名字，比如hello.txt 改为 1 hello.txt，即名字前标记数字（并留空一格），这样就能手工调整各个文档的排序。

　　如果某文档的状态是draft，那么在目录导出PDF的时候，它会被排除在外。

　　PDF的导出可以针对每个文件夹，如果是整个网站文件夹导出，可以右键点击Category列表的第一项（~/）进行导出。

　　PDF的导出需要消耗比较高的CPU资源，文字内容越多，渲染的时间越长；一般5万字需要1分钟左右的时间。

　　Mac/Linxu版本在导出PDF的时候，Editor本身不会卡顿；由于Windows的系统限制，导出PDF的时候，整个程序会卡住直到完成，此时，请耐心等待。

　　由于Editor会自动同步你的数据到FarBox服务器中，你除了完成一本电子书之外，还可以选择一个合适的模板，来呈现所有的内容。

　　历史版本对比

　　在文件管理器中，右键点击一篇文章，可以查看其历史版本。在历史版本弹窗里，有着与当前文章的记录对比。一般来说，红色背景的，-开头的，表示这行是被删除的；绿色背景，+开头的，表示这行是刚增加的。

　　你或许发现，这个版本对比很像程序员写代码时用的…… 但Editor并不是基于Git或者类似的技术，而是用相对纯粹的历史纪录来实现，这样可以最大程度地让普通用户去使用它，比如你正在做一些文章的校对，它就显得很有作用了。

　　长微博导出

　　在正文区域，鼠标右键，可以看到『导出图片到粘贴板』，然后在浏览器中打开新浪微博，再在发微博区域Ctrl+V（Mac版为Command+V）即可将长微博图片粘贴过去。

　　如果需要Markdown渲染后的HTML内容，则在预览区中鼠标右键，进行操作。

　　具体导出图片的设置项，包括边距、宽，可以在Editor的设置中设定。

　　另外，长微博这个名词，把导出图片的功能限制在微博上了，实际上，你同样可以发布到微信朋友圈。由于手机上一般都是Retina（高清）屏幕，缩放率为1的图片，会显得模糊；那么，将导出图片的缩放率设定为2，就显得非常重要了。

　　注意：

　　预览区导出的图片，不支持底部的自定义签名。

　　如果不是直接将图片导入到粘贴板的，也可以右键后，选择『导出为图片』，这样就会另存为图片文件了。

　　写作软件

　　FarBox Web Editor: 通过www.farbox.com登录后的页面进入，或者http://yourdomain.com/admin/editor进入；这是一个比较简洁的Editor。

　　FarBox桌面Editor: 点击此处下载（推荐！），目前支持Win/Mac，除了日常写作记录外，还能将一个文件夹导出为PDF的电子书。

　　其它APP（苹果系）: Mou, iA Writer, Byword

　　像iA Writer和Byword是跨平台的，有iPhone/iPad端，并且支持Dropbox（也就是可以直接编辑、保存到FarBox的网站里）。

　　其它写作软件，只要把自己的文章保存到FarBox的对应网站里，效果也是一样的。

　　基本规则

　　文件名即文章的标题

　　文件内容，即文章正文

　　文章的文件名，其后缀支持.txt .md .markdown .mk四种格式。

　　插入图片

　　在FarBox Editor中，你只需要把图片拖入文本区域就可以了。

　　你也可以使用Markdown的语法![]()直接插入图片，图片为相对网站目录的路径，比如/_image/your_photo.jpg。

　　修改文章的属性

　　FarBox使用统一的配置语法来实现文档的属性扩展, 下面将对一些常用的属性做简单介绍。

　　如果一篇文章是如下格式的：

　　Date: 2012-10-25 12:22

　　Title: 我是文章的标题

　　Tags: 标签1, 标签2

　　Status: draft

　　URL： this-is-my-first-post

　　然后开始写正文...

　　Date可以设置文章发表时间

　　Title可以设置文章的标题（如果不想用文件名做标题）

　　Tags可以设置文章的标签。如果标签中没有连词的，直接使用空格；如果有连词的话，使用英文状态下的,进行分割即可

　　Status表示文章的状态，默认的是public。日志列表内输出的一般都是public属性的文章，像上面示例中draft则表示不在网站里出现。

　　URL用来自定义文章的地址，如无必要，请不要定制。

　　这里仅对主要的几个属性进行了说明，如果需要了解更多，请访问>日志的属性

　　如果正在使用FarBox的客户端Editor，正文就直接写，扩展的属性则需要在点击底部meta按钮后跳出的弹窗内书写才有效。

　　关于Markdown

　　FarBox默认支持Markdown的语法（也可以在网站后台中禁止Markdown）, 一般情况下，你不了解Markdown也能正常使用。

　　一般的Markdown格式是要求两个换行才算是真正视觉上的换行，而在FarBox则不遵循这个规则（文件后缀名为.mk的除外）。

　　多数情况下，在使用Markdown格式时，出现的格式问题可以通过这样的方式解决：多（或者少）一个空格、换行。

　　如果你发现自己文章内不能以Markdown的格式被浏览，请确保网站设置里，没有将文章的显示模式设为“平文本”！

　　以下特性是FarBox特殊支持的Markdown语法：

　　表格

　　一个表格看起来如下所示:

　　First Header | Second Header | Third Header

　　Content Cell | Content Cell | Content Cell

　　Content Cell | Content Cell | Content Cell

　　脚注

　　This is emphatically [^1]

　　Something else [^key2].

　　EOF

　　代码高亮

　　如果声明代码语言的，会进行代码高亮的处理；代码块需要分别用三个反引号（一般在键盘1键的左侧）包裹。

　　```python

　　codes

　　```

　　如果语言后面多一个:n，则会显示代码的行号。

　　```python:n

　　codes

　　```

　　代码的高亮的具体样式是由CSS控制的，由Pygments生成。你可以访问Pygments Styles查看常见的几种风格。

　　插入gist

　　单独一行，`gist gist_id`就可以了。反引号`是必须的，以避免跟其它普通文字产生潜在的冲突。

　　Mathjax

　　```mathjax

　　your mathjax codes.

　　```

　　这样的写法，会被解析为Mathjax能够处理的脚本。但前提你已经知道Mathjax是如何运作的，或者直接在网站的后台管理中另外启用数学公式。

常见问题

　　日志的分类怎么处理？

　　文件夹即分类，如果模板支持分类（比如默认模板就是支持的），一般都是按照这样的约定实现的；所以，你只需要把自己的日志按照不同文件夹存放就可以了。

　　相册是怎么生成的？

　　有照片的文件夹即相册，一般都是按照这个约定实现的；但也有些模板不支持相册功能。

　　你也可以只使用默认模板，且保证里面没有日志，那么自己的网站就是一个相册站点了。

　　如何托管静态网站？

　　如果是整站托管，请确保网站目录下有index.html这个文件。

　　如果是某个子目录的，请确保子目录内有index.html这个文件, 并且URL是以/结尾的。

　　关于FarBox

　　FarBox是什么机制？

　　当你的文件保存到本地的时候，通过Dropbox的同步机制，或者FarBox Editor的同步机制，将数据同步到FarBox的服务器后，我们进行以下处理：

　　获取更新的内容，数据结构化以供调用;

　　有人访问时，根据模板对API的调用，动态渲染每个页面。

　　简而言之，FarBox将你的个人云，从单纯的存储进化为一台Web服务器。

　　我必须要使用Dropbox吗？

　　不一定，如果你正在使用FarBox Edtior，那么，它也是负责数据同步的客户端。即使，你不使用FarBox Editor，直接在线写写文章就足够了，也是可以的。

　　FarBox会访问我Drobox的其它资料么？

　　不会！除了对应的APP目录外，我们没有这个权限。

　　Dropbox会限制我的网站访问量么？

　　不会。你的网站产生的所有访问，都来自于FarBox，而非Dropbox。

　　FarBox是静态网站么？

　　不是。我们是纯动态的网站，支持站内的全文搜索、访问数、评论、网站数据统计等功能。

　　网站相关

　　什么叫站点目录、网站目录？

　　两者是同一个概念。表示直接隶属于FarBox的文件夹。

　　--| FarBox （这个是通过DropBox自动创建的，自建无效）

　　--| site-folder-1 （这是一个网站目录）

　　--| sub folder (二级目录，不再是网站目录了)

　　--| site-folder-2 （这也是一个网站目录）

　　如何创建、删除一个网站?

　　只需创建/删除一个对应的网站目录就可以了。 用域名(比如test.farbox.com)来命名网站目录是一个常见、并且推荐的方法。

　　使用FarBox提供的评论系统，数据会自动保存到我的电脑里么？

　　是的。如果访客对你的一篇文章（或图片）进行评论，那么在这篇文章所在的目录中，会有一个相对应的评论文档（文本文档类型），用以存放、同步你的评论内容。

　　什么是多说ID？

　　如果你的一个网站设置的多说评论，其中多说的域名为abcdefg.duoshuo.com，那么你当前要用到的多说ID就是abcdefg。

　　如果无法使用、或者不知道如何使用多说，请联系多说的工作人员。

　　如何修改favicon.ico

　　把favicon.ico这个文件放到自己网站的目录内，等同步完成就可以了。一般浏览器对favicon.ico有比较长的缓存期，有时清空缓存都不会起作用。如果要比较快看到效果，请切换浏览器进行查看。

　　同步相关

　　Dropbox和FarBox Editor可以同时使用么，会有冲突么？

　　可以。但是FarBox Editor也是一个同步客户端，机制类似Dropbox，所以，同时使用，有比较大概率会产生冲突。

　　以下方法，可以避免同步冲突：

　　如果关联了Dropbox，那么FarBox Editor内就不要进行登录，利用Dropbox的同步机制就可以了。

　　不要关联Dropbox；或者，不要让Dropbox处于运行状态；或者，不要让Dropbox对FarBox目录进行同步。

　　为什么我修改了文件、文章，访问网站的时候，一点变化都没有，很久了都一样？

　　请确保这个网站（对应的域名）是你的。比如尝试去管理这个网站，是否有权限管理？

　　因为，最有可能的是，你创建了两个甚至以上的账户，或者对应域名的网站已经被别人占用。

　　又或者你创建了两个以上网站但绑定了同一个域名，所以你访问到了你不期望的网站，另一个存在却无法访问到。

　　为什么我的Dropbox目录内没有FarBox这个文件夹？

　　如果你在中国大陆居住，第一次使用Dropbox帐号登录FarBox后，可能需要重启Dropbox，才会看到这个这个文件夹。

　　这个文件夹一般位于Dropbox/应用/FarBox，如果你是Dropbox的早期用户（或英文用户），也有可能位于Dropbox/Apps/FarBox。

　　注意：这个目录是由Dropbox创建的，自己手工创建是无效的！

　　为什么我的图片无法同步，文章改个标题就不见了？

　　请查看http://yourdomain.com/service/status，自己的授权状态是否失效了？如果失效了，重新进行一次授权就可以了。

　　如何重新授权？就是进入FarBox首页，使用你的账号进行一次登录就可以了。

　　为什么我有些文章，在Dropbox不存在，但网站上却有？

　　这是一个小概率事件，因为某些Dropbox未能捕获到的移动文件位置或者重命名的操作，被FarBox Editor或者其它FarBox第三方的APP捕获到了。

　　一般情况下，网站会在2个小时内对这些需要确认的内容进行一次校验，然后删除。

　　为什么我的一些文章突然就消失了？

　　如果你使用FarBox Editor进行写作，但是又关闭了Dropbox超过2个小时以上，这种情况下会遇到这个问题。

　　只需要重新打开Dropbox，等数据自动同步后，消失的文章会重新出现的。

　　模板相关

　　为什么我的自定义模板不生效？

　　进入网站管理后台，在模板引擎中找到模板优先级的设置，并设置为自定义模板优先就可以了。

　　默认情况下是自动，也就是克隆模板优先（如果有的话），而在网站后台里选的FarBox提供的模板，也属于克隆模板的性质。