From c135fa8b7e0e25cd2094174d62621b0c1d6dca60 Mon Sep 17 00:00:00 2001 From: Dan Date: Sat, 29 Aug 2015 09:27:40 +0700 Subject: [PATCH] Update README.md --- README.md | 78 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 75 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 94634b4..cae80e6 100644 --- a/README.md +++ b/README.md @@ -144,10 +144,29 @@ This will produce a hash which is to be placed in the `password` field in `usern Both Online or Offline ---------------------- -The built-in editor found in the admin panel, also provides you the ability to write to Markdown files offline by uploading them (see naming convention below) into the `content/username/blog/category/type/` folder (the `username` must match `YourUsername.ini` above). +The built-in editor found in the admin panel, also provides you the ability to write to Markdown files offline by uploading them (see naming convention below) into the `content/username/blog/category/type/`: + +* `username` must match `config/users/username.ini`. +* `category` must match the `category.md` inside `content/data/category/category.md` except the `uncategorized` category. +* `type` is the content type. Available content type `post`, `video`, `audio`, `link`, `quote`. For static pages you can upload it to the `content/static` folder. +Category +-------- +The default category is `Uncategorized` with slug `uncategorized` and you do not need to creating it inside `content/data/category/` folder. But if you write it offline and want to assign new category to specific post you need to creating it first before you can use those category, example `content/data/category/new-category.md` with the following content: + +```html + + + +New category info etc. +```` +The slug for the new category is `new-category` (htmly removing the file extension). And for full file directory: +```` +content/username/new-category/post/file.md +```` + File Naming Convention ---------------------- When you write a blog post and save it via the admin panel, HTMLy automatically create a .md file extension with the following name, example: @@ -182,17 +201,70 @@ content/static/about/me.md This will create the URL: `www.yourblog.com/about/me` -Content Title +Content Tags ------------- -If you are writing offline, to create a title for your post, wrap the title with an HTML comment and a `t` on both side. +If you are writing offline, you need specify the content tags below: +**Title** ```html ```` +**Meta description** +```html + +```` + +**Tags** + +This is just the tags display and for the slug is in the filename. +```html + +```` + +**Featured image** + +Post with featured image. +```html + +```` + +**Featured youtube video** + +Post with featured youtube video. +```html + +```` + +**Featured soundcloud audio** + +Post with featured soundcloud audio. +```html + +```` + +**Featured link** + +Post with featured link. +```html + +```` + +**Featured quote** + +Post with featured quote. +```html + +```` + +**Example** + Example of how your post would look like: ```html + + + Paragraph 1