diff --git a/README.md b/README.md index c332d88..6029495 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,12 @@ HTMLy ===== -HTMLy is an open source databaseless blogging platform prioritizing simplicity and speed. +HTMLy is an open source databaseless blogging platform prioritizing simplicity and speed (Flat-File Blog). And because HTMLy also manage the contents, then it can be referred as a Flat-File CMS. You do not need to use a VPS to run HTMLy, fairly shared hosting or even a free hosting as long as those hosting already support at least PHP 5.3. Features --------- - - Admin panel - Markdown editor with live preview - Categorization with tags (multi tags support) @@ -28,29 +27,24 @@ Features - JSON API - OPML - RSS Feed -- RSS Import +- RSS 2.0 Importer (basic) - Sitemap.xml - Archive and tag cloud widget -- SEO friendly URL +- SEO friendly URLs - Teaser thumbnail for images and Youtube videos -- Responsive design +- Responsive design Requirements ------------ - HTMLy requires PHP 5.3 or greater. Installations ------------- - -Download the latest version, extract it, then upload the extracted files to your server. Make sure the installation folder or at least the `content` folder is writeable by your server. - -If HTMLy uploaded using FTP than sometimes the `content` folder is owned by those FTP user, if so please chmod the `content` folder to 0777 instead. +Download the latest version, extract it, then upload the extracted files to your server. Make sure the installation folder is writeable by your server. Configurations -------------- - -Rename `config.ini.example` inside `config` folder to `config.ini`, and than create `YourUsername.ini` inside `config/users` folder, write down your password there. +Rename `config.ini.example` inside `config` folder to `config.ini` or you can create it one than change the site settings there, create `YourUsername.ini` inside `config/users` folder or simply rename the `username.ini.example`, write down your password there. ```` password = YourPassword @@ -60,25 +54,23 @@ You can login to admin panel at `www.example.com/login`. Both Online or Offline ---------------------- - -In addition using the built-in editor in the admin panel, you can also write it offline and then upload them into `content/username/blog` folder (the username must match with `YourUsername.ini` above). +In addition by using the built-in editor in the admin panel, you can also write it offline and then upload them into `content/username/blog` folder (the username must match with `YourUsername.ini` above). For static pages you can upload it to `content/static` folder. 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.md +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` is the tag, separated by comma -- `databaseless-blogging-platform` is the URL +- `databaseless-blogging-platform-flat-file-blog` is the URL For static pages, we use the following format: @@ -92,7 +84,6 @@ So if you write it offline then you must naming the .md file as above. Content Title ------------- - If you write it offline, for the title of the post you need to add a title in the following format: @@ -105,12 +96,10 @@ So wrap the title with HTML comment with `t` for both side. Demo ---- - Visit a real blog powered by HTMLy at [Danlogs](http://www.danlogs.com). Credit ------ - People who give references and inspiration for HTMLy: * [Martin Angelov](http://tutorialzine.com) @@ -119,8 +108,6 @@ Contribute 1. Fork and edit 2. Submit pull request for consideration - Copyright / License ------------------- - -For copyright notice please read [COPYRIGHT.txt](https://github.com/danpros/htmly/blob/master/COPYRIGHT.txt). HTMLy licensed under the GNU General Public License Version 2.0 (or later). +For copyright notice please read [COPYRIGHT.txt](https://github.com/danpros/htmly/blob/master/COPYRIGHT.txt). HTMLy licensed under the GNU General Public License Version 2.0 (or later). \ No newline at end of file diff --git a/content/.htaccess b/content/.htaccess deleted file mode 100644 index 3418e55..0000000 --- a/content/.htaccess +++ /dev/null @@ -1 +0,0 @@ -deny from all \ No newline at end of file diff --git a/content/readme.txt b/content/readme.txt deleted file mode 100644 index 49d10a5..0000000 --- a/content/readme.txt +++ /dev/null @@ -1,2 +0,0 @@ -This folder must writeable by your server. -If HTMLy uploaded using FTP than sometimes this folder owned by FTP user, if so please chmod this folder to 0777 instead. \ No newline at end of file