readme-again (2648B)
1 bliper (BLog engine In PERl) v0.2 2 ================================= 3 4 A perl script that reads all posts from main-articles/ as markdown and creates 5 them as HTML articles in output/ dir. It also reads and creates individual 6 pages based on files that exist in pages/ directory. 7 8 Deps: Text-Markdown (http://search.cpan.org/~bobtfish/Text-Markdown-1.000031/) 9 10 It also creates a main page as index.html with all links to posts and pages 11 generated. 12 13 Files included are: 14 15 . 16 |-- LICENSE 17 |-- README 18 |-- TODO 19 |-- bin 20 | |-- bliper-create-post.sh 21 | |-- bliper-deploy.sh 22 | |-- bliper-generate.pl 23 | `-- bliper-menu-creation.sh 24 |-- main-articles 25 | |-- 2013-11-07-readme 26 | `-- 2013-11-10-markdown-notes 27 |-- output 28 | |-- images 29 | | `-- puffytron.jpg 30 | `-- style.css 31 |-- pages 32 | |-- about 33 | `-- contact 34 `-- template 35 |-- footer 36 |-- main-bottom 37 |-- main-top 38 |-- page-bottom 39 `-- page-top 40 41 _bin/bliper-create-post.sh_ 42 use this instead of `touch <file>` for your posts. It just prepends `date '+%Y-%m-%d'` to the beginning of the filename. 43 44 _bin/bliper-deploy.sh_ 45 is a script tha "deploys" the website. It's based on rsync and I've 46 included a sample config. Just change "user@host:/path/to/output" with 47 the real one. 48 49 _bin/bliper-generate.pl_ 50 is the main script that parses every post in input/ and recreates it as 51 HTML in output/. It also creates the index.html page and appends all links 52 to posts. 53 54 _bin/bliper-menu-creation.sh_ 55 upon generation, a file called 'tmp' gets created. Then, this script 56 replaces all "insertmenu"(in capital) strings in templates with the 57 real menu. Nothing fancy, but you need to run this before deployment or 58 viewing to generate your menus in all pages. 59 60 _main-articles_ 61 is the directory which serves as the place to create all posts in markdown. 62 63 _output_ 64 is the directory which all generated pages are placed. Edit the style.css 65 file according to your needs. 66 67 _pages_ 68 is the directory which produced all new pages (again, sample included). 69 70 _template_ 71 main-top is the top section of the main page. 72 main-bottom is the bottom section of the main page. 73 page-top is a generic template for the top section of any post page. 74 page-bottom is a generic template for the bottom section of any post page. 75 footer is just the footer appended in all pages. 76 77 I've included a demo file in input/markdown-notes. Just run `bliper-generate.pl` in your main directory, `bliper-menu-creation.sh` and `$BROWSER output/index.html` to see the demo. There is also the option to rsync the files to your server with `bliper-deploy.sh`