bliper

static html page generation in perl
git clone git@git.2f30.org/bliper.git
Log | Files | Refs | README | LICENSE

2013-11-27-readme (3588B)


      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/ and pages-b/ 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-blog.sh
     21 	|   |-- bliper-create-post.sh
     22 	|   |-- bliper-deploy.sh
     23 	|   |-- bliper-generate.pl
     24 	|   `-- bliper-menu-creation.sh
     25 	|-- main-articles
     26 	|   |-- 2013-11-07-readme
     27 	|   `-- 2013-11-10-markdown-notes
     28 	|-- Makefile
     29 	|-- output
     30 	|   |-- images
     31 	|   |   `-- puffytron.jpg
     32 	|   `-- style.css
     33 	|-- pages
     34 	|   |-- about
     35 	|   `-- contact
     36 	|-- pages-b
     37 	|   `-- readme-again
     38 	`-- template
     39 	    |-- footer
     40 	    |-- main-bottom
     41 	    |-- main-top
     42 	    |-- page-bottom
     43 	    `-- page-top
     44 
     45 _bin/bliper-blog.pl_
     46 	simple script to check if posts exist in main-articles/. If no posts exist, 'blog' page will not be created.
     47 
     48 _bin/bliper-create-post.sh_
     49 	use this instead of `touch <file>` for your posts. It just prepends `date '+%Y-%m-%d'` to the beginning of the filename.
     50 
     51 _bin/bliper-deploy.sh_
     52 	is a script tha "deploys" the website. It's based on rsync and I've included a sample config. Just change "user@host:/path/to/output" with the real one.
     53 
     54 _bin/bliper-generate.pl_
     55 	is the main script that parses every post in input/ and recreates it as HTML in output/. It also creates the index.html page and appends all links to posts.
     56 
     57 _bin/bliper-menu-creation.sh_
     58 	upon generation, a file called 'tmp' gets created. Then, this script comes and replaces all "insertmenu" (in capital) strings in templates with the real menu. Nothing fancy, but you need to run this before deployment or viewing to generate your menus in all pages.
     59 
     60 _main-articles_
     61 	files in this directory will be linked in 'blog' page. If no articles exist, blog page will not be created.
     62 
     63 _Makefile_
     64 	just type 'make' to generate your site. It calls bin/bliper-generate.pl and bin/bliper-menu-creation.sh. When you edit your bin/bliper-deploy.sh, you can deploy your site with 'make deploy'. Possible options are: make, make clean, make deploy.
     65 
     66 _output_
     67 	is the directory which all generated pages are placed. Edit the style.css file according to your needs.
     68 
     69 _pages_
     70 	is the directory where all individual pages live (check the included sample).
     71 
     72 _pages-b_
     73 	is the directory which produces pages that do not appear on the menu. You can link to them through other pages with markdown.
     74 
     75 _template_
     76 	main-top is the top section of the main page.
     77 	main-bottom is the bottom section of the main page.
     78 	page-top is a generic template for the top section of any post page.
     79 	page-bottom is a generic template for the bottom section of any post page. footer is just the footer appended in all pages.
     80 
     81 To view the demo, run `make` in your main bliper directory. This calls bin/bliper-generate.pl and bin/bliper-menu-creation.sh. If you need to view the results, just run `$BROWSER output/index.html`
     82 
     83 When your site is ready, edit `bin/bliper-deploy.sh` accordingly and just `make deploy` on your main bliper directory.
     84 
     85 There is also support for disqus individualy for pages and articles. Just uncomment the disqus section on template/article-bottom and/or template/pate-bottom to enable disqus on articles and/or pages.
     86 
     87 [This](readme-again.html) is a test to a page that came from pages-b.