mirror of
https://github.com/danpros/htmly.git
synced 2026-04-21 13:06:22 +05:30
Revert "Brh55 english updates"
This commit is contained in:
Kanti
parent
4fe21632f1
commit
b57bc4de8c
2 changed files with 32 additions and 45 deletions
75
README.md
75
README.md
|
|
@ -1,27 +1,27 @@
|
||||||
HTMLy
|
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, since it will also manage your content.
|
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, shared hosting or even free hosting should work as long as the host supports at least PHP 5.3.
|
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
|
Features
|
||||||
---------
|
---------
|
||||||
- Admin Panel
|
- Admin panel
|
||||||
- Markdown editor with live preview
|
- Markdown editor with live preview
|
||||||
- Categorization with tags (multiple tagging support)
|
- Categorization with tags (multi tags support)
|
||||||
- Static Pages (e.g. Contact Page, About Page)
|
- Static pages Eg. for contact page
|
||||||
- Meta canonical, description, and rich snippets for SEO
|
- Meta canonical, description, and rich snippets for SEO
|
||||||
- Pagination
|
- Pagination
|
||||||
- Author Page
|
- Author page
|
||||||
- Multi author support
|
- Multi author support
|
||||||
- Social Links
|
- Social links
|
||||||
- Disqus Comments (optional)
|
- Disqus Comments (optional)
|
||||||
- Facebook Comments (optional)
|
- Facebook Comments (optional)
|
||||||
- Google Analytics
|
- Google Analytics
|
||||||
- Built-in Search
|
- Built-in search
|
||||||
- Related Posts
|
- Related posts
|
||||||
- Per Post Navigation (previous and next post)
|
- Per post navigation (previous and next post)
|
||||||
- Body class for easy theming
|
- Body class for easy theming
|
||||||
- Breadcrumb
|
- Breadcrumb
|
||||||
- Archive page (by year, year-month, or year-month-day)
|
- Archive page (by year, year-month, or year-month-day)
|
||||||
|
|
@ -30,14 +30,14 @@ Features
|
||||||
- RSS Feed
|
- RSS Feed
|
||||||
- RSS 2.0 Importer (basic)
|
- RSS 2.0 Importer (basic)
|
||||||
- Sitemap.xml
|
- Sitemap.xml
|
||||||
- Archive and Tag Cloud Widget
|
- Archive and tag cloud widget
|
||||||
- SEO Friendly URLs
|
- SEO friendly URLs
|
||||||
- Teaser thumbnail for images and Youtube videos
|
- Teaser thumbnail for images and Youtube videos
|
||||||
- Responsive Design
|
- Responsive design
|
||||||
- Lightbox
|
- Lightbox
|
||||||
- User Roles
|
- User role
|
||||||
- Online Backup
|
- Online backup
|
||||||
- File Caching
|
- File cache
|
||||||
- Auto Update
|
- Auto Update
|
||||||
|
|
||||||
Requirements
|
Requirements
|
||||||
|
|
@ -46,8 +46,8 @@ HTMLy requires PHP 5.3 or greater.
|
||||||
|
|
||||||
Installations
|
Installations
|
||||||
-------------
|
-------------
|
||||||
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 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, 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.
|
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.
|
||||||
|
|
||||||
Configurations
|
Configurations
|
||||||
--------------
|
--------------
|
||||||
|
|
@ -59,19 +59,18 @@ Create `YourUsername.ini` inside the `config/users` folder or simply rename the
|
||||||
password = YourPassword
|
password = YourPassword
|
||||||
````
|
````
|
||||||
|
|
||||||
In addition, HTMLy support admin user role. To do so, simply add the following line to your choosen user:
|
HTMLy support admin user role either, simply add the following to your choosen user:
|
||||||
|
|
||||||
````cfg
|
````cfg
|
||||||
role = admin
|
role = admin
|
||||||
````
|
````
|
||||||
|
|
||||||
Users assigned with the admin role can edit/delete all users' posts.
|
A user 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.
|
You can login to admin panel at `www.example.com/login`.
|
||||||
e.g. `www.yoursite.com/login`
|
|
||||||
|
|
||||||
### Lighttpd
|
### Lighttpd
|
||||||
The following is an example configuration for lighttpd:
|
Here a example configuration
|
||||||
|
|
||||||
````php
|
````php
|
||||||
$HTTP["url"] =~ "^/config" {
|
$HTTP["url"] =~ "^/config" {
|
||||||
|
|
@ -94,7 +93,7 @@ url.rewrite-once = (
|
||||||
````
|
````
|
||||||
|
|
||||||
### Nginx
|
### Nginx
|
||||||
The following is a basic configuration for Nginx:
|
Here a basic configuration for nginx.
|
||||||
|
|
||||||
````nginx
|
````nginx
|
||||||
server {
|
server {
|
||||||
|
|
@ -127,11 +126,7 @@ server {
|
||||||
|
|
||||||
Both Online or Offline
|
Both Online or Offline
|
||||||
----------------------
|
----------------------
|
||||||
<<<<<<< HEAD
|
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).
|
|
||||||
=======
|
|
||||||
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).
|
|
||||||
>>>>>>> 1fda3d7a35f0fc4d6251bb0f6eb1782647986064
|
|
||||||
|
|
||||||
For static pages you can upload it to the `content/static` folder.
|
For static pages you can upload it to the `content/static` folder.
|
||||||
|
|
||||||
|
|
@ -149,35 +144,27 @@ Here's the explanation (separated by an underscore):
|
||||||
- `tag1,tag2,tag3` are the tags, separated by commas
|
- `tag1,tag2,tag3` are the tags, separated by commas
|
||||||
- `databaseless-blogging-platform-flat-file-blog` is the URL
|
- `databaseless-blogging-platform-flat-file-blog` is the URL
|
||||||
|
|
||||||
For static pages, use the following format:
|
For static pages, we use the following format:
|
||||||
|
|
||||||
````
|
````
|
||||||
content/static/about.md
|
content/static/about.md
|
||||||
````
|
````
|
||||||
|
|
||||||
In the example above, the `/about.md` creates the URL:
|
That means the URL is `about`.
|
||||||
`www.yourblog.com/about`
|
|
||||||
|
|
||||||
Thus, if you write/create files offline, you must name the .md file in the format above.
|
So if you write it offline then you must name the .md file as above.
|
||||||
|
|
||||||
For static subpages, use the following format:
|
For static sub pages, we use the following format:
|
||||||
|
|
||||||
````
|
````
|
||||||
content/static/about/me.md
|
content/static/about/me.md
|
||||||
````
|
````
|
||||||
|
|
||||||
This will create the URL:
|
That means the URL is `about/me`.
|
||||||
`www.yourblog.com/about/me`
|
|
||||||
|
|
||||||
Content Title
|
Content Title
|
||||||
-------------
|
-------------
|
||||||
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 write it offline, for the title of the post you need to add a title in the following format:
|
||||||
|
|
||||||
```html
|
|
||||||
<!--t Title t-->
|
|
||||||
````
|
|
||||||
|
|
||||||
Example of how your post would look like:
|
|
||||||
```html
|
```html
|
||||||
<!--t Here is the post title t-->
|
<!--t Here is the post title t-->
|
||||||
|
|
||||||
|
|
@ -185,7 +172,7 @@ Paragraph 1
|
||||||
|
|
||||||
Paragraph 2 etc.
|
Paragraph 2 etc.
|
||||||
```
|
```
|
||||||
|
So wrap the title with HTML comment with `t` for both side.
|
||||||
|
|
||||||
Demo
|
Demo
|
||||||
----
|
----
|
||||||
|
|
@ -212,4 +199,4 @@ Contributors
|
||||||
|
|
||||||
Copyright / License
|
Copyright / License
|
||||||
-------------------
|
-------------------
|
||||||
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).
|
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).
|
||||||
|
|
|
||||||
|
|
@ -1 +1 @@
|
||||||
Place your theme folder here, but don't modify the default theme. Doing so may cause merge conflicts or overrides in your custom changes.
|
Put your theme folder here but don't modify the default theme.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue