From 13bec2eacc9eded6b84e590561f1d9550e4d4ef7 Mon Sep 17 00:00:00 2001 From: Brandon Him Date: Sat, 18 Apr 2015 19:36:33 -0400 Subject: [PATCH 01/12] update README.MD Update wording and grammatical errors. --- README.md | 69 +++++++++++++++++++++++++++++++++++---------------------------- 1 file changed, 38 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 82f034f..edec96f 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,27 @@ HTMLy ===== -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. +HTMLy is an open source databaseless, blogging platform that prioritizes simplicity and speed (Flat-File Blog). HTMLy can be referred to as a Flat-File CMS, as it will also manage your content. You do not need to use a VPS to run HTMLy, shared hosting or even free hosting should work as long as the host supports at least PHP 5.3. Features --------- -- Admin panel +- Admin Panel - Markdown editor with live preview -- Categorization with tags (multi tags support) -- Static pages Eg. for contact page +- Categorization with tags (multiple tagging support) +- Static Pages (e.g. Contact Page, About Page) - Meta canonical, description, and rich snippets for SEO - Pagination -- Author page +- Author Page - Multi author support -- Social links +- Social Links - Disqus Comments (optional) - Facebook Comments (optional) - Google Analytics -- Built-in search -- Related posts -- Per post navigation (previous and next post) +- Built-in Search +- Related Posts +- Per Post Navigation (previous and next post) - Body class for easy theming - Breadcrumb - Archive page (by year, year-month, or year-month-day) @@ -30,14 +30,14 @@ Features - RSS Feed - RSS 2.0 Importer (basic) - Sitemap.xml -- Archive and tag cloud widget -- SEO friendly URLs +- Archive and Tag Cloud Widget +- SEO Friendly URLs - Teaser thumbnail for images and Youtube videos -- Responsive design +- Responsive Design - Lightbox -- User role -- Online backup -- File cache +- User Roles +- Online Backup +- File Caching - Auto Update Requirements @@ -46,8 +46,8 @@ HTMLy requires PHP 5.3 or greater. Installations ------------- -if you have openssl on your server, use the [Installer](https://github.com/Kanti/htmly-installer/releases/latest). read the [Instructions](https://github.com/Kanti/htmly-installer/blob/master/README.md#htmly-installerphp). -If you don't have openssl, download the latest version, extract it, then upload the extracted files to your server. Make sure the installation folder is writeable by your server. +If you have OpenSSL on your server, use the [installer](https://github.com/Kanti/htmly-installer/releases/latest) and read the following [instructions](https://github.com/Kanti/htmly-installer/blob/master/README.md#htmly-installerphp) to get started. +If you don't have OpenSSL, please download the latest version, extract it, then upload the extracted files to your server. Also, make sure the installation folder is writeable by your server. Configurations -------------- @@ -59,18 +59,19 @@ Create `YourUsername.ini` inside the `config/users` folder or simply rename the password = YourPassword ```` -HTMLy support admin user role either, simply add the following to your choosen user: +In addition, HTMLy support admin user role. To do so, simply add the following line to your choosen user: ````cfg role = admin ```` -A user with the admin role can edit/delete all users' posts. +Users assigned with the admin role can edit/delete all users' posts. -You can login to admin panel at `www.example.com/login`. +To access the admin panel, add `/login` to the end of your site's URL. +IE: `www.yoursite.com/login` ### Lighttpd -Here a example configuration +The following are example configuration for lighttpd: ````php $HTTP["url"] =~ "^/config" { @@ -93,7 +94,7 @@ url.rewrite-once = ( ```` ### Nginx -Here a basic configuration for nginx. +The following are basic configuration for Nginx: ````nginx server { @@ -126,7 +127,7 @@ server { Both Online or Offline ---------------------- -In addition by using the built-in editor in the admin panel, you can also write markdown files offline and then upload them (see naming convention below) into the `content/username/blog` 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` folder (the `username` must match `YourUsername.ini` above). For static pages you can upload it to the `content/static` folder. @@ -144,27 +145,33 @@ Here's the explanation (separated by an underscore): - `tag1,tag2,tag3` are the tags, separated by commas - `databaseless-blogging-platform-flat-file-blog` is the URL -For static pages, we use the following format: +For static pages, use the following format: ```` content/static/about.md ```` -That means the URL is `about`. +In the example above, the `/about.md` creates the URL: `www.yourblog.com/about`. -So if you write it offline then you must name the .md file as above. +Thus, if you write/create files offline, you must name the .md file in the format above. -For static sub pages, we use the following format: +For static subpages, use the following format: ```` content/static/about/me.md ```` -That means the URL is `about/me`. +This will create the following URL: `www.yourblog.com/about/me`. Content Title ------------- -If you write it offline, for the title of the post you need to add a title in the following format: +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. + +```html + +```` + +Example of how your post would look like: ```html @@ -172,7 +179,7 @@ Paragraph 1 Paragraph 2 etc. ``` -So wrap the title with HTML comment with `t` for both side. + Demo ---- @@ -199,4 +206,4 @@ Contributors 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 is licensed under the GNU General Public License Version 2.0 (or later). From 2bd616a176fa1c358081ba4d7e684a44327b079f Mon Sep 17 00:00:00 2001 From: Brandon Him Date: Sat, 18 Apr 2015 19:39:52 -0400 Subject: [PATCH 02/12] Update readme.txt Update to add importance of not modifying default theme. --- themes/readme.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/themes/readme.txt b/themes/readme.txt index 1c29a7d..e5793a3 100644 --- a/themes/readme.txt +++ b/themes/readme.txt @@ -1 +1 @@ -Put your theme folder here but don't modify the default theme. \ No newline at end of file +Put your theme folder here, but don't modify the default theme. As pulling updates will cause merge conflicts or overriding your changes. From 9e19b68dd3abc5097fb39e8a300f1cf2685f81d9 Mon Sep 17 00:00:00 2001 From: Brandon Him Date: Sat, 18 Apr 2015 19:44:32 -0400 Subject: [PATCH 03/12] Minor small text visual changes --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index edec96f..2cf7d55 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ role = admin Users assigned with the admin role can edit/delete all users' posts. To access the admin panel, add `/login` to the end of your site's URL. -IE: `www.yoursite.com/login` +e.g. `www.yoursite.com/login` ### Lighttpd The following are example configuration for lighttpd: @@ -151,7 +151,8 @@ 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`. +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. @@ -161,7 +162,8 @@ For static subpages, use the following format: content/static/about/me.md ```` -This will create the following URL: `www.yourblog.com/about/me`. +This will create the URL: +`www.yourblog.com/about/me` Content Title ------------- From c5011a5ebfbe178ecc5caa9cc0661739ec65e44a Mon Sep 17 00:00:00 2001 From: Brandon Him Date: Sat, 18 Apr 2015 19:45:19 -0400 Subject: [PATCH 04/12] update README.MD --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2cf7d55..3a1f8c8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ HTMLy ===== -HTMLy is an open source databaseless, blogging platform that prioritizes simplicity and speed (Flat-File Blog). HTMLy can be referred to as a Flat-File CMS, as it will also manage your content. +HTMLy is an open source databaseless, blogging platform that prioritizes simplicity and speed (Flat-File Blog). HTMLy can be referred to as a Flat-File CMS, since it will also manage your content. You do not need to use a VPS to run HTMLy, shared hosting or even free hosting should work as long as the host supports at least PHP 5.3. From 1fda3d7a35f0fc4d6251bb0f6eb1782647986064 Mon Sep 17 00:00:00 2001 From: Brandon Him Date: Sat, 18 Apr 2015 19:51:59 -0400 Subject: [PATCH 05/12] minor small grammar change --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3a1f8c8..1cda20f 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ To access the admin panel, add `/login` to the end of your site's URL. e.g. `www.yoursite.com/login` ### Lighttpd -The following are example configuration for lighttpd: +The following is an example configuration for lighttpd: ````php $HTTP["url"] =~ "^/config" { @@ -94,7 +94,7 @@ url.rewrite-once = ( ```` ### Nginx -The following are basic configuration for Nginx: +The following is a basic configuration for Nginx: ````nginx server { From 358e0a186ce761ac641eea3a04a9e83a7b0c1dab Mon Sep 17 00:00:00 2001 From: Brandon Him Date: Sat, 18 Apr 2015 19:36:33 -0400 Subject: [PATCH 06/12] update README.MD Update wording and grammatical errors. --- README.md | 69 +++++++++++++++++++++++++++++++++++---------------------------- 1 file changed, 38 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 4db089c..e75301b 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,27 @@ HTMLy ===== -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. +HTMLy is an open source databaseless, blogging platform that prioritizes simplicity and speed (Flat-File Blog). HTMLy can be referred to as a Flat-File CMS, as it will also manage your content. You do not need to use a VPS to run HTMLy, shared hosting or even free hosting should work as long as the host supports at least PHP 5.3. Features --------- -- Admin panel +- Admin Panel - Markdown editor with live preview -- Categorization with tags (multi tags support) -- Static pages Eg. for contact page +- Categorization with tags (multiple tagging support) +- Static Pages (e.g. Contact Page, About Page) - Meta canonical, description, and rich snippets for SEO - Pagination -- Author page +- Author Page - Multi author support -- Social links +- Social Links - Disqus Comments (optional) - Facebook Comments (optional) - Google Analytics -- Built-in search -- Related posts -- Per post navigation (previous and next post) +- Built-in Search +- Related Posts +- Per Post Navigation (previous and next post) - Body class for easy theming - Breadcrumb - Archive page (by year, year-month, or year-month-day) @@ -30,14 +30,14 @@ Features - RSS Feed - RSS 2.0 Importer (basic) - Sitemap.xml -- Archive and tag cloud widget -- SEO friendly URLs +- Archive and Tag Cloud Widget +- SEO Friendly URLs - Teaser thumbnail for images and Youtube videos -- Responsive design +- Responsive Design - Lightbox -- User role -- Online backup -- File cache +- User Roles +- Online Backup +- File Caching - Auto Update Requirements @@ -46,8 +46,8 @@ HTMLy requires PHP 5.3 or greater. Installations ------------- -if you have openssl on your server, use the [Installer](https://github.com/Kanti/htmly-installer/releases/latest). read the [Instructions](https://github.com/Kanti/htmly-installer/blob/master/README.md#htmly-installerphp). -If you don't have openssl, [download](https://github.com/danpros/htmly/releases/latest) the latest version, extract it, then upload the extracted files to your server. Make sure the installation folder is writeable by your server. +If you have OpenSSL on your server, use the [installer](https://github.com/Kanti/htmly-installer/releases/latest) and read the following [instructions](https://github.com/Kanti/htmly-installer/blob/master/README.md#htmly-installerphp) to get started. +If you don't have OpenSSL, please download the latest version, extract it, then upload the extracted files to your server. Also, make sure the installation folder is writeable by your server. Configurations -------------- @@ -59,18 +59,19 @@ Create `YourUsername.ini` inside the `config/users` folder or simply rename the password = YourPassword ```` -HTMLy support admin user role either, simply add the following to your choosen user: +In addition, HTMLy support admin user role. To do so, simply add the following line to your choosen user: ````cfg role = admin ```` -A user with the admin role can edit/delete all users' posts. +Users assigned with the admin role can edit/delete all users' posts. -You can login to admin panel at `www.example.com/login`. +To access the admin panel, add `/login` to the end of your site's URL. +IE: `www.yoursite.com/login` ### Lighttpd -Here a example configuration +The following are example configuration for lighttpd: ````php $HTTP["url"] =~ "^/config" { @@ -93,7 +94,7 @@ url.rewrite-once = ( ```` ### Nginx -Here a basic configuration for nginx. +The following are basic configuration for Nginx: ````nginx server { @@ -126,7 +127,7 @@ server { Both Online or Offline ---------------------- -In addition by using the built-in editor in the admin panel, you can also write markdown files offline and then upload them (see naming convention below) into the `content/username/blog` 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` folder (the `username` must match `YourUsername.ini` above). For static pages you can upload it to the `content/static` folder. @@ -144,27 +145,33 @@ Here's the explanation (separated by an underscore): - `tag1,tag2,tag3` are the tags, separated by commas - `databaseless-blogging-platform-flat-file-blog` is the URL -For static pages, we use the following format: +For static pages, use the following format: ```` content/static/about.md ```` -That means the URL is `about`. +In the example above, the `/about.md` creates the URL: `www.yourblog.com/about`. -So if you write it offline then you must name the .md file as above. +Thus, if you write/create files offline, you must name the .md file in the format above. -For static sub pages, we use the following format: +For static subpages, use the following format: ```` content/static/about/me.md ```` -That means the URL is `about/me`. +This will create the following URL: `www.yourblog.com/about/me`. Content Title ------------- -If you write it offline, for the title of the post you need to add a title in the following format: +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. + +```html + +```` + +Example of how your post would look like: ```html @@ -172,7 +179,7 @@ Paragraph 1 Paragraph 2 etc. ``` -So wrap the title with HTML comment with `t` for both side. + Demo ---- @@ -199,4 +206,4 @@ Contributors 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 is licensed under the GNU General Public License Version 2.0 (or later). From 9cf785114cb3e454470fc9860948e22d79986c04 Mon Sep 17 00:00:00 2001 From: Brandon Him Date: Sat, 18 Apr 2015 19:39:52 -0400 Subject: [PATCH 07/12] Update readme.txt Update to add importance of not modifying default theme. --- themes/readme.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/themes/readme.txt b/themes/readme.txt index 1c29a7d..e5793a3 100644 --- a/themes/readme.txt +++ b/themes/readme.txt @@ -1 +1 @@ -Put your theme folder here but don't modify the default theme. \ No newline at end of file +Put your theme folder here, but don't modify the default theme. As pulling updates will cause merge conflicts or overriding your changes. From 7c775585e0c0aac96c5ee19c2f09bc9e601a2fdb Mon Sep 17 00:00:00 2001 From: Brandon Him Date: Sat, 18 Apr 2015 19:44:32 -0400 Subject: [PATCH 08/12] Minor small text visual changes --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e75301b..156d03d 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ role = admin Users assigned with the admin role can edit/delete all users' posts. To access the admin panel, add `/login` to the end of your site's URL. -IE: `www.yoursite.com/login` +e.g. `www.yoursite.com/login` ### Lighttpd The following are example configuration for lighttpd: @@ -151,7 +151,8 @@ 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`. +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. @@ -161,7 +162,8 @@ For static subpages, use the following format: content/static/about/me.md ```` -This will create the following URL: `www.yourblog.com/about/me`. +This will create the URL: +`www.yourblog.com/about/me` Content Title ------------- From 7784466ce72657f48318d393763557bdb74b12d7 Mon Sep 17 00:00:00 2001 From: Brandon Him Date: Sat, 18 Apr 2015 19:45:19 -0400 Subject: [PATCH 09/12] update README.MD --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 156d03d..7aab96c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ HTMLy ===== -HTMLy is an open source databaseless, blogging platform that prioritizes simplicity and speed (Flat-File Blog). HTMLy can be referred to as a Flat-File CMS, as it will also manage your content. +HTMLy is an open source databaseless, blogging platform that prioritizes simplicity and speed (Flat-File Blog). HTMLy can be referred to as a Flat-File CMS, since it will also manage your content. You do not need to use a VPS to run HTMLy, shared hosting or even free hosting should work as long as the host supports at least PHP 5.3. From 28c4d15d2b1d99cf2a00c5b3048f95434f533415 Mon Sep 17 00:00:00 2001 From: Brandon Him Date: Sat, 18 Apr 2015 19:51:59 -0400 Subject: [PATCH 10/12] minor small grammar change --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7aab96c..32419c9 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ To access the admin panel, add `/login` to the end of your site's URL. e.g. `www.yoursite.com/login` ### Lighttpd -The following are example configuration for lighttpd: +The following is an example configuration for lighttpd: ````php $HTTP["url"] =~ "^/config" { @@ -94,7 +94,7 @@ url.rewrite-once = ( ```` ### Nginx -The following are basic configuration for Nginx: +The following is a basic configuration for Nginx: ````nginx server { From 0b6ae8143e51ccd02fe0186ff9551e3ab7a89d5e Mon Sep 17 00:00:00 2001 From: Brandon Him Date: Wed, 22 Apr 2015 09:32:20 -0400 Subject: [PATCH 11/12] brh55 update to theme readme.txt --- themes/readme.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/themes/readme.txt b/themes/readme.txt index e5793a3..696cb6c 100644 --- a/themes/readme.txt +++ b/themes/readme.txt @@ -1 +1 @@ -Put your theme folder here, but don't modify the default theme. As pulling updates will cause merge conflicts or overriding your changes. +Put your theme folder here, but don't modify the default theme, as pulling updates will cause merge conflicts or overriding your changes. From 1ecf45811e17db758b5853d85ec81b4caa300860 Mon Sep 17 00:00:00 2001 From: Brandon Him Date: Wed, 22 Apr 2015 09:37:10 -0400 Subject: [PATCH 12/12] brh55 update theme.txt, to be a bit more proper --- themes/readme.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/themes/readme.txt b/themes/readme.txt index 696cb6c..e778e69 100644 --- a/themes/readme.txt +++ b/themes/readme.txt @@ -1 +1 @@ -Put your theme folder here, but don't modify the default theme, as pulling updates will cause merge conflicts or overriding your changes. +Place your theme folder here, but don't modify the default theme. Doing so may cause merge conflicts or overrides in your custom changes.