Browse Source

Prepare for initial release

Prepare for initial release. Updating the readme file etc.
pull/31/merge
Danang Probo Sayekti 12 years ago
parent
commit
33bdbe81b5
3 changed files with 82 additions and 5 deletions
  1. +6
    -0
      COPYRIGHT.txt
  2. +76
    -4
      README.md
  3. +0
    -1
      system/admin/views/edit-profile.html.php

+ 6
- 0
COPYRIGHT.txt View File

@ -27,3 +27,9 @@ license, including:
Markdown - Copyright (c) 2003-2006 John Gruber Markdown - Copyright (c) 2003-2006 John Gruber
\Suin\RSSWriter - Copyright (c) Suin <https://github.com/suin> \Suin\RSSWriter - Copyright (c) Suin <https://github.com/suin>
Showdown code (c) 2007 John Fraser
Pagedown modifications and bugfixes (c) 2009 Dana Robinson
Pagedown modifications and bugfixes (c) 2009-2013 Stack Exchange Inc.

+ 76
- 4
README.md View File

@ -3,6 +3,34 @@ 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.
Features:
---------
- Admin panel
- Markdown editor with live preview
- Categorization with tags (multi tags support)
- Static pages Eg. for contact page
- Meta canonical, description, and markup for SEO
- Pagination
- Author page
- Multi author support
- Social links
- Disqus Commenting System
- Google Analytics
- 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)
- JSON API
- OPML
- RSS Feed
- Sitemap.xml
- Archive and tag cloud widget
- SEO friendly URL
- Teaser thumbnail for images and Youtube videos.
Requirements Requirements
------------ ------------
@ -16,13 +44,58 @@ Download the latest version, extract it, then upload the extracted files to your
Configurations Configurations
-------------- --------------
Change **config.ini** inside **config** folder, and than create **YourUsername.ini** inside **config/users** folder, write down your password there.
Change `config.ini` inside `config` folder, and than create `YourUsername.ini` inside `config/users` folder, write down your password there.
```` ````
password = YourPassword password = YourPassword
```` ````
You can login to admin panel at `www.example.com/admin`.
You can login to admin panel at `www.example.com/login`.
Both Online or Offline
----------------------
In addition to 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_tag1,tag2,tag3_databaseless-blogging-platform.md
````
Here's the explanation (separated by an underscore):
- `2014-01-31-12-56` is the published date. The date format is `yyyy-mm-dd-hh-mm`
- `tag1,tag2,tag3` is the tag, separated by comma
- `databaseless-blogging-platform` is the URL
For static pages, we use the following format:
````
about.md
````
That is means if `about` is the URL.
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:
<!--t Here is the post title t-->
Paragraph 1
Paragraph 2 etc.
So wrap the title with HTML comment with `t` for both side.
Demo Demo
---- ----
@ -36,8 +109,7 @@ People who give references and inspiration for HTMLy:
* [Martin Angelov](http://tutorialzine.com) * [Martin Angelov](http://tutorialzine.com)
Copyright / License 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).

+ 0
- 1
system/admin/views/edit-profile.html.php View File

@ -34,7 +34,6 @@
Title: <br><input type="text" name="title" class="text" value="<?php echo $oldtitle?>"/><br><br> Title: <br><input type="text" name="title" class="text" value="<?php echo $oldtitle?>"/><br><br>
<div id="wmd-button-bar" class="wmd-button-bar"></div> <div id="wmd-button-bar" class="wmd-button-bar"></div>
<textarea id="wmd-input" class="wmd-input" name="content" cols="20" rows="10"><?php echo $oldcontent ?></textarea><br> <textarea id="wmd-input" class="wmd-input" name="content" cols="20" rows="10"><?php echo $oldcontent ?></textarea><br>
<input type="hidden" name="oldfile" class="text" value="<?php echo $url ?>"/>
<input type="submit" name="submit" class="submit" value="Submit"/> <input type="submit" name="submit" class="submit" value="Submit"/>
</form> </form>
</div> </div>


Loading…
Cancel
Save