Update docs

Author: whtsky

README.rst

@@ -4,8 +4,8 @@ Catsup
 .. image:: https://pypip.in/d/catsup/badge.png
         :target: https://pypi.python.org/pypi/catsup/
 
-.. image:: https://travis-ci.org/whtsky/catsup.png?branch=develop
-        :target: https://travis-ci.org/whtsky/catsup
+.. image:: https://travis-ci.org/whtsky/Catsup.png?branch=develop
+        :target: https://travis-ci.org/whtsky/Catsup
 
 .. image:: https://coveralls.io/repos/whtsky/catsup/badge.png?branch=develop
         :target: https://coveralls.io/r/whtsky/catsup?branch=develop

docs/install.rst

@@ -10,14 +10,14 @@ If you are using OS X , make sure you have installed the *Command Line Tools* .
 
 Install using pip
 -------------------------
-Install catsup via pip is easy ::
+Install Catsup via pip is easy ::
 
     (sudo) pip install catsup
 
 
 Upgrade from older version
 -------------------------------
-It's also easy to upgrade your catsup ::
+It's also easy to upgrade your Catsup ::
 
     (sudo) pip install catsup --upgrade
 
@@ -38,7 +38,7 @@ Install with git can always have the latest code ::
 
 Cann’t find Python.h ?
 -----------------------
-Catsup uses misaka as the markdown engine.It requires C compiler.On Ubuntu, you may run ::
+Catsup uses misaka as the markdown engine. It requires C compiler.On Ubuntu, you may run ::
 
     (sudo) apt-get install python-dev
 

docs/post.rst

@@ -3,10 +3,17 @@
 Post Syntax
 =============
 
+Catsup currently supports 3 types of post: :ref:`Markdown <post-markdown-syntax>`, :ref:`Text <post-text-syntax>` and :ref:`HTML <post-html-syntax>`.
+
+.. _post-markdown-syntax:
+
+Markdown Post
+--------------
+
 Overview
------------
+~~~~~~~~~
 
-A post's extension should be either ``.md`` or ``.markdown`` .
+Post's extension should be either ``.md`` or ``.markdown`` .
 
 A sample post looks like ::
 
@@ -29,21 +36,80 @@ A sample post looks like ::
 A post consists of three parts:
 
 + Title
-+ Meta
++ :ref:`Meta <post-meta>`
 + Content
 
 Title
---------
+~~~~~~~~~~~~~~~~~~~~~~
 
 Title should always on the first line and starts with ``#``
 
+Content
+~~~~~~~~~~~~~~~~~~~~~~
+
+Everything below the separator is the content. Content should be written in Markdown.
+
+Code Highlight
+~~~~~~~~~~~~~~~~~~~~~~
+
+Catsup supports GitHub's style code highlight, like this ::
+
+    ```python
+    print("Hello World!")
+    ```
+
+.. _post-text-syntax:
+
+Text Post
+--------------
+
+Sometimes you may just want to write something without considering the syntax. Then you should use Text Post.
+
+Text post's extension should be ``.txt`` .
+
+The simplest text post looks like ::
+
+    Hello!
+    This is a text post.
+
+If you want to write meta in a text post, write the meta in YAML format ::
+
+    ---
+    title: Hello, World!
+    tags: Hello, World
+    time: 2014-01-04 20:56
+    ---
+
+    Hello, World! I'm a text post.
+
+
+.. _post-html-syntax:
+
+HTML Post
+--------------
+
+HTML post is like :ref:`Text <post-text-syntax>`, but you can use HTML in the content.
+
+HTML post's extension should be ``.txt`` .
+
+A HTML post looks like ::
+
+    ---
+    title: Hello, World!
+    tags: Hello, World
+    time: 2014-01-04 20:56
+    ---
+
+    <p>I'm writing HTML in catsup</p>
+
+
 .. _post-meta:
 
 Meta
--------
-
-Meta is some information about the post. It's below title and above the separator.
+--------
 
+Meta is some information about the post.
+Note that meta is optional, and if your post have meta, remember to put a :ref:`separator <post-separator>` below the meta.
 
 + time: When the post is written. like ``2013-08-25 11:10``
 + tags: Tags of the post. Separated by comma, like ``Python, Program``
@@ -52,8 +118,10 @@ Meta is some information about the post. It's below title and above the separato
 + comment: Set to ``disabled`` to forbid comment
 + permalink: Permalink to the post, link ``/this-post``
 
+.. _post-separator:
+
 The separator
----------------
+----------------
 
 The separator separates meta and content. It should be at least *three* ``-`` ::
 
@@ -63,21 +131,6 @@ It's okay to make it longer ::
 
     ----------------
 
-Content
------------
-
-Everything below the separator is the content. Content should be written in Markdown.
-
-Code Highlight
------------------
-
-Catsup supports GitHub's style code highlight, like this ::
-
-    ```python
-    print("Hello World!")
-    ```
-
-
 Page
 --------