Upload Markdown to make a blog
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
php-markdown @ 9dbd835
php-query @ 41b2ff3
posts
special
templates
upblog
.gitattributes
.gitignore
.gitmodules
.htaccess
LICENSE.txt
README.md
SETUP.md
config.php
index.php
load.php
nav.php
posts-cache.php
summaries.php
upblog.php
web.config

README.md

Upblog

Upload Markdown to make a blog... Upblog. Goals: simple in setup and operation, minimal code, runs on cheap PHP servers.

So You Want to Write Markdown and Upload it to Make a Blog

Great! Upblog is built to work as soon as you configure it with your domain information:

  • Fork or check out Upblog
  • Upload it to your server that has PHP 5-ish
  • Configure config.php with your blog root (read the comments)
  • Configure .htaccess to point all requests to your index.php

There are plenty of extra config things you can do in config.php if you want to. If you don't want upblog errors to display, make some CSS (in the master template) that styles .upblog-error with display: none; ... but be careful! :)

See also SETUP.md

Adding a post

Write a test.md file or use this README (rename it test.md). Upload it to your posts/ directory as configured in config.php. Now, in the browser, go to your-site.com/blog/test, except replace your-site.com with your domain name and blog/ with whatever you put in config.php:BLOG_ROOT of course!

After you upload a markdown file to your posts directory, go to your blog root + /load to load the changes.

Templates

Upblog looks in ~/templates and if it finds a template matching the name of the page (e.g. 'index.php' for 'index.md') then it will use that. Otherwise it uses the master.php file in the templates directory.

You can configure the location of the templates directory in config.php

A template can make use of the following variables to output post content and metadata:

<?=$UPBLOG?> //Render the post
<?=$TITLE?> //Title of the post. Put it in the <title> tag
<?=nav(6)?> //Output a <ul> of nav items. Optional limit as parameter.
<?=summaries(10)?> //Output the summaries of recent posts. Optional limit.
<?=link_newer('No newer posts')?> //Output a hyperlink to the next post. Optional fallback text.
<?=link_older('This is the first post')?> //Output a hyperlink to the previous post. Optional fallback text.
<?=twitter_card()?> //Output a summary-mode twitter card for the post

How it works

Your .htaccess file should redirect the request for /blog/test to /blog/index.php, which picks up the actual request. Then it looks in the posts directory for a markdown file with that name. It converts it to HTML and puts it in the $UPBLOG variable. It renders the master template, which should echo the contents of that variable.

File conventions

Write your blog posts in Markdown. Name them with the post title in lowercase with dashes-between-words and ending in .md:

some-thoughts-on-blogging.md
index.md

License

For License information, see LICENSE.txt

php-markdown is courtesy of Michel Fortin php-query is courtesy of Tobaisz Cudnik


Stephen Griffiths 2014 - @SteGriff - github@stegriff.co.uk