Added first version of README

This commit is contained in:
Stefan Ritter 2009-12-06 21:03:55 +01:00
parent af6f93cc1f
commit b6341ec2f1

55
README Normal file
View File

@ -0,0 +1,55 @@
Index:
1) Entries
2) Staticpages
3) Comments
4) Linklist
1) Entries
To start blogging you just have to open your favorite editor, write your entry
and save it under entries/. The filename should be like this:
(entry title).(suffix)
The suffix can be set in your configuration file. Default is '.txt'.
While parsing an entry, blogthon places a <br /> behind each line, except for
lines with <ul>, <li>, <table>, etc... So you don't need to make your own
layout using <br /> tags. Aside from that you can certainly use <p> elements
and all other HTML tags.
Time and date of your entry are taken from the timestamp of your file.
Unfortunately this timestamp changes when you edit your file again. As a
workaround I use a small shellscript instead of starting vim/emacs/...:
http://git.fucktheforce.de/?p=xeno;a=blob_plain;f=viod;hb=HEAD
2) Staticpages
Staticpages are placed under static/ without a suffix. To sort them, you can
start the filename with a literal and -. So '01-Foo' will be placed before
'02-Bar'.
If you want to make a staticpage to be a link to an extern page, you just have
to place the following content in the first line:
extern_link: http://your/link.
3) Comments
Comments are saved under entries/ like all entries, but with the suffix
'.comments'. The syntax in this file is like this:
-.Nickname
+.Date
.some text
.more text
4) Linklist
To add a link to your linklist, just add a line to the linklist file:
http://some/link name of your link
Of course you can use empty lines to split different sorts of links.