commit 132a475c740e26d9efcead3f1a85bf7a16fdeccb
parent 3cb1a96882109028e4821b6ad2ed4b420faeebeb
Author: cipher <haris@2f30.org>
Date: Wed, 26 Mar 2014 16:01:29 +0200
Edit README to reflect recent changes
Diffstat:
2 files changed, 55 insertions(+), 52 deletions(-)
diff --git a/README b/README
@@ -3,7 +3,7 @@ bliper (BLog engine In PERl) v0.2
A perl script that reads all posts from main-articles/ as markdown and creates
them as HTML articles in output/ dir. It also reads and creates individual
-pages based on files that exist in pages/ directory.
+pages based on files that exist in pages/ and pages-b/ directory.
Deps: Text-Markdown (http://search.cpan.org/~bobtfish/Text-Markdown-1.000031/)
@@ -17,6 +17,7 @@ Files included are:
|-- README
|-- TODO
|-- bin
+| |-- bliper-blog.sh
| |-- bliper-create-post.sh
| |-- bliper-deploy.sh
| |-- bliper-generate.pl
@@ -41,6 +42,10 @@ Files included are:
|-- page-bottom
`-- page-top
+bin/bliper-blog.pl
+ simple script to check if posts exist in main-articles/. If no posts
+ exist, 'blog' page will not be created.
+
bin/bliper-create-post.sh
use this instead of `touch <file>' for your posts. It just prepends `date
'+%Y-%m-%d'` to the beginning of the filename.
@@ -62,19 +67,22 @@ bin/bliper-menu-creation.sh
viewing to generate your menus in all pages.
main-articles
- is the directory which serves as the place to create all posts in markdown.
+ files in this directory will be linked in 'blog' page. If no articles
+ exist, blog page will not be created.
Makefile
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'
+ bin/bliper-deploy.sh, you can deploy your site with 'make deploy'.
+ Possible options are: make, make clean, make deploy.
output
is the directory which all generated pages are placed. Edit the style.css
file according to your needs.
pages
- is the directory which produced all new pages (again, sample included).
+ is the directory where all individual pages live (check the included
+ sample).
pages-b
is the directory which produces pages that do not appear on the menu.
diff --git a/main-articles/2013-11-27-readme b/main-articles/2013-11-27-readme
@@ -3,7 +3,7 @@ bliper (BLog engine In PERl) v0.2
A perl script that reads all posts from main-articles/ as markdown and creates
them as HTML articles in output/ dir. It also reads and creates individual
-pages based on files that exist in pages/ directory.
+pages based on files that exist in pages/ and pages-b/ directory.
Deps: Text-Markdown (http://search.cpan.org/~bobtfish/Text-Markdown-1.000031/)
@@ -12,76 +12,71 @@ generated.
Files included are:
- .
- |-- LICENSE
- |-- README
- |-- TODO
- |-- bin
- | |-- bliper-create-post.sh
- | |-- bliper-deploy.sh
- | |-- bliper-generate.pl
- | `-- bliper-menu-creation.sh
- |-- main-articles
- | |-- 2013-11-07-readme
- | `-- 2013-11-10-markdown-notes
- |-- output
- | |-- images
- | | `-- puffytron.jpg
- | `-- style.css
- |-- pages
- | |-- about
- | `-- contact
- |-- pages-b
- | `-- readme-again
- `-- template
- |-- footer
- |-- main-bottom
- |-- main-top
- |-- page-bottom
- `-- page-top
+ .
+ |-- LICENSE
+ |-- README
+ |-- TODO
+ |-- bin
+ | |-- bliper-blog.sh
+ | |-- bliper-create-post.sh
+ | |-- bliper-deploy.sh
+ | |-- bliper-generate.pl
+ | `-- bliper-menu-creation.sh
+ |-- main-articles
+ | |-- 2013-11-07-readme
+ | `-- 2013-11-10-markdown-notes
+ |-- Makefile
+ |-- output
+ | |-- images
+ | | `-- puffytron.jpg
+ | `-- style.css
+ |-- pages
+ | |-- about
+ | `-- contact
+ |-- pages-b
+ | `-- readme-again
+ `-- template
+ |-- footer
+ |-- main-bottom
+ |-- main-top
+ |-- page-bottom
+ `-- page-top
+
+_bin/bliper-blog.pl_
+ simple script to check if posts exist in main-articles/. If no posts exist, 'blog' page will not be created.
_bin/bliper-create-post.sh_
- use this instead of `touch <file>` for your posts. It just prepends `date '+%Y-%m-%d'` to the beginning of the filename.
+ use this instead of `touch <file>' for your posts. It just prepends `date '+%Y-%m-%d'` to the beginning of the filename.
_bin/bliper-deploy.sh_
- 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.
+ 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.
_bin/bliper-generate.pl_
- 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.
+ 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.
_bin/bliper-menu-creation.sh_
- upon generation, a file called 'tmp' gets created. Then, this script
- 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.
+ 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.
_main-articles_
- is the directory which serves as the place to create all posts in markdown.
+ files in this directory will be linked in 'blog' page. If no articles exist, blog page will not be created.
_Makefile_
- 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'
+ 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.
_output_
- is the directory which all generated pages are placed. Edit the style.css
- file according to your needs.
+ is the directory which all generated pages are placed. Edit the style.css file according to your needs.
_pages_
- is the directory which produced all new pages (again, sample included).
+ is the directory where all individual pages live (check the included sample).
_pages-b_
- is the directory which produces pages that do not appear on the menu.
- You can link to them through other pages with markdown.
+ is the directory which produces pages that do not appear on the menu. You can link to them through other pages with markdown.
_template_
main-top is the top section of the main page.
main-bottom is the bottom section of the main page.
page-top is a generic template for the top section of any post page.
- page-bottom is a generic template for the bottom section of any post page.
- footer is just the footer appended in all pages.
+ page-bottom is a generic template for the bottom section of any post page. footer is just the footer appended in all pages.
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`
