abstracted choosing file
[pb.git] / README.md
1 All you really need is just the pb file, the others are there for demonstration purposes, you can just download that file by itself if you don't want the extra garbage.
2
3 # 'Installation'
4 Before running the script, open it up and change the variables at the top of the file to your liking.
5
6 You need a couple of things to get the script:
7 - A blog index file (a page with a list of all of your posts)
8 - A rolling blog file (a feed of posts will be placed here)
9 - A rss file
10
11 In each of these files, you need to include the comments:
12 ```
13 <!-- BLOG START -->
14 <!-- BLOG END -->
15
16 ```
17
18 # Usage
19 ### n / new
20
21 ### p / publish
22
23 ### d / delete
24
25
26 # Configuration
27 For more fine tuned configuration, navigate to the data\_dir directory that was created (by default it's blog/) and find the templates folder.
28 These are the html snippets that get included in your index, rolling and rss files.
29 You can use certain keywords that will be substituted in:
30 - {{TITLE}} for the title of the blog post
31 - {{DATE}}
32 - {{URL}} pointing to that post
33 - {{BODY}} the html of that post