just-a-blog

A bad blogging software that converts Markdown into PHP for some reason.
Log | Files | Refs | LICENSE

README.md (2208B)

      1 # just-a-blog
      2 A simple blog software that doesn't require a database, and separates content from presentation.
      3 
      4 ## Features
      5 - Respects the user
      6   - just-a-blog tries to stay out of your way as much as possible.
      7   - Doesn't force jquery or any other framework on you.
      8   - Degrades gracefully for screenreaders or text-only environments
      9   - You can use your preferred tool for editing pages and posts. 
     10 - Compatible
     11   - just-a-blog only requires PHP5+. No databases are necessary.
     12   - Can port existing HTML pages and posts directly into just-a-blog with no need to reformat. (Just remember to change the extension to .md)
     13 - Full customization - Since just-a-blog strives to be small and lightweight, editing it should be extremely easy.
     14 - No frameworks, no package managers. Just put the php files on your server in your preferred method. I guess you could do this with other softwares, but JAB *encourages* it.
     15 
     16 ## Install
     17 
     18 Installing is dead simple. Simply `git clone https://github.com/robertdherb/just-a-blog` in the directory you serve http pages from. You will also need to make some changes to your httpd to allow it to serve canonical URLs.
     19 
     20 ## Use
     21 
     22 Place markdown files in the posts/ directory. The file name should be the post's title. For instance, a post titled, "My First Post" should be in the file posts/my-first-post.md.
     23 
     24 Pages work the same, but are placed in the pages/ directory.
     25 
     26 Do not delete pages/home.md. Alter it however you like, but it needs to exist.
     27 
     28 Posts are sorted by last edit time. This moves recently edited posts to the top of the list. This may or may not be a desirable outcome for you.
     29 
     30 ## TODO
     31 
     32  - Make it easier to siwtch cannonical URLs on and off
     33  - Maybe categories/tags?
     34  - Make better use of the write_html() function in functions.php (lots of display-related stuff currently can't be changed without editing that file!)
     35 
     36 ## Contact
     37 Send an email to just-a-blog@robertdherb.com, or try to find me on Skype (rawbherb) or Steam (abigtimeoperator)
     38 
     39 ## License
     40 just-a-blog is currently released under the BSD 2-Clause License. See LICENSE for more details.
     41 
     42 ## Credits
     43 just-a-blog uses [Parsedown](https://github.com/erusev/parsedown) by [Emanuil Rusev](erusev.com).