diff --git a/README.md b/README.md index ff40aa8..75646ca 100644 --- a/README.md +++ b/README.md @@ -149,6 +149,134 @@ $ php -a ```` This will produce a hash which is to be placed in the `password` field in `username.ini`. Ensure that the `encryption` field is set to `password_hash`. + +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/`: + +* `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: + +```` +2014-01-31-12-56-40_tag1,tag2,tag3_databaseless-blogging-platform-flat-file-blog.md +```` + +Here's the explanation (separated by an underscore): + +- `2014-01-31-12-56-40` is the published date. The date format is `yyyy-mm-dd-hh-mm-ss` +- `tag1,tag2,tag3` are the tags, separated by commas +- `databaseless-blogging-platform-flat-file-blog` is the URL + +For static pages, use the following format: + +```` +content/static/about.md +```` + +In the example above, the `/about.md` creates the URL: `www.yourblog.com/about` + +Thus, if you write/create files offline, you must name the .md file in the format above. + +For static subpages, use the following format: + +```` +content/static/about/me.md +```` + +This will create the URL: `www.yourblog.com/about/me` + +Content Tags +------------- +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 + +Paragraph 2 etc. +``` + Contribute ---------- 1. Fork and edit diff --git a/themes/blog/layout.html.php b/themes/blog/layout.html.php index 092df03..0120048 100644 --- a/themes/blog/layout.html.php +++ b/themes/blog/layout.html.php @@ -20,14 +20,7 @@ - - +