commit c7fc7b930dfc7e45b38a1290f286d7c94d8a30a0
parent 0dcdac2814dbb4f7e7f862402c2c8a21e5342be6
Author: Christos Margiolis <christos@margiolis.net>
Date: Sun, 15 Nov 2020 17:21:13 +0200
pending minor bug fixes
Diffstat:
| M | Makefile | | | 1 | + |
| A | README | | | 51 | +++++++++++++++++++++++++++++++++++++++++++++++++++ |
| D | README.md | | | 73 | ------------------------------------------------------------------------- |
| M | blogindex.html | | | 10 | +++++----- |
| M | index.html | | | 10 | +++++----- |
| M | sbrs | | | 125 | ++++++++++++++++++++++++++++++++++++++++--------------------------------------- |
| M | sbrs.1 | | | 6 | +++--- |
| M | styles.css | | | 31 | +++++++++++++------------------ |
| M | template.html | | | 10 | +++++----- |
9 files changed, 146 insertions(+), 171 deletions(-)
diff --git a/Makefile b/Makefile
@@ -1,4 +1,5 @@
# See LICENSE file for copyright and license details.
+.POSIX:
BIN = sbrs
VERSION = 0.1
diff --git a/README b/README
@@ -0,0 +1,51 @@
+sbrs
+====
+A small and simple blog and RSS shell script written in POSIX shell.
+
+Preparation
+-----------
+Inside the 'sbrs' script, change the 'WEBSITE' and 'AUTHOR' variables
+to match your website's URL and your name.
+
+In case you don't edit the script further, the structure of your
+website's directory should should like this. The
+files below need to exist with the same names.
+
+ ├── blog
+ | └── here reside your blog posts
+ ├── index.html
+ ├── blogindex.html
+ ├── template.html
+ └── rss.xml
+
+Inside 'index.html', 'blogindex.html' and 'rss.xml' sbrs will search for
+<!--BLOG--> in order to put the blog post listings and RSS feed below it.
+
+The 'template.html' file is how you want your blog post's page to look like.
+See my own 'template.html' for more. The 'TITLE', 'HEADER' and 'AUTHOR'
+fields must exist and be left as is.
+
+Installation
+------------
+sbrs will be installed in /usr/local/bin
+
+ cd path/to/sbrs/
+ sudo make install
+
+Usage
+-----
+You must always run the script inside your website's main directory.
+Run it with one of the following options. Only one option can be used
+at a time.
+
+Options:
+ -n New post
+ -p Publish draft post
+ -e Edit draft post
+ -v View draft post in browser
+ -t Delete draft post
+ -r Revise published post
+ -c Change title
+ -o View published post in browser
+ -d Delete published post
+ -l List all published posts
diff --git a/README.md b/README.md
@@ -1,73 +0,0 @@
-# sbrs
-
-A small and simple blog and RSS shell script written in POSIX shell.
-
-## Features
-
-`sbrs` can do the following:
-
-* Define a `blog` directory where all blog posts will be stored.
-* Set up a seperate `HTML` blog page with CSS styling of your choosing.
-* Add the blog post on the website's main and blog index pages.
-* Add the blog post to a specified RSS feed.
-* Revise, delete, or change the title of a published post.
-
-Read the `man` page for more.
-
-## Installation
-
-Run the `Makefile` in order to install the script. It'll
-be installed in `usr/local/bin/`. You can change the install path
-by editing the `BIN_DIR` variable in the `Makefile`.
-
-```shell
-$ cd path/to/sbrs/
-$ sudo make install
-```
-
-You must **always** run the script inside your website's
-main directory.
-
-Alternatively, you can store the script inside your website's
-main directory.
-
-## Preparation
-
-The following files have to exist
-* `index.html`
-* `blogindex.html`
-* `rss.xml`
-* `template.html`
-* `styles.css`
-
-Inside the `sbrs` script, change the `website` and `author` variables
-to your website's URL and your name and make sure the rest
-of the variables are properly set to match your website's
-structure. By default, all blog posts are stored in `blog/`.
-
-`sbrs` will search for `<!--BLOG-->` inside `index.html`,
-`blogindex.html` and `rss.xml` in order to put the blog post
-listings and RSS feed below it.
-
-The `template.html` file is how you want your blog post's page to look like. See
-my own `template.html` for more. The `TITLE`, `HEADER` and `AUTHOR`
-fields must exist and be left as is.
-
-## Usage
-
-You can run the script with one of the following
-options
-
-```
-Options:
- -n New post
- -p Publish draft post
- -e Edit draft post
- -v View draft post in browser
- -t Delete draft post
- -r Revise published post
- -c Change title
- -o View published post in browser
- -d Delete published post
- -l List all published posts
-```
diff --git a/blogindex.html b/blogindex.html
@@ -1,12 +1,12 @@
<!DOCTYPE html>
<html>
- <head>
+<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css"/>
<title>Blog Index</title>
- </head>
+</head>
- <body>
- <!--BLOG-->
- </body>
+<body>
+ <!--BLOG-->
+</body>
</html>
diff --git a/index.html b/index.html
@@ -1,15 +1,15 @@
<!DOCTYPE html>
<html>
- <head>
+<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css"/>
<title>Website Index</title>
- </head>
+</head>
- <body>
+<body>
<h2>Recent blog posts</h2>
<ul>
- <!--BLOG-->
+ <!--BLOG-->
</ul>
- </body>
+</body>
</html>
diff --git a/sbrs b/sbrs
@@ -1,36 +1,35 @@
#!/bin/sh
# See LICENSE file for copyright and license details.
-website="https://christosmarg.xyz"
-author="Christos Margiolis"
-blogdir="blog"
-draftdir=".drafts"
-blogindex="blogindex.html"
-index="index.html"
-rssfile="rss.xml"
-template="template.html"
+WEBSITE="https://christosmarg.xyz"
+AUTHOR="Christos Margiolis"
+BLOGDIR="blog"
+DRAFTDIR=".drafts"
+BLOGINDEX="blogindex.html"
+INDEX="index.html"
+RSSFILE="rss.xml"
+TEMPLATE="template.html"
[ -z "$EDITOR" ] && EDITOR="vim"
main() {
missing_check
case $1 in
-n*) newpost ;;
- -p*) listposts $draftdir && publish ;;
- -e*) listposts $draftdir && $EDITOR $draftdir/$blogpost.html ;;
- -v*) listposts $draftdir && view ;;
- -t*) listposts $draftdir && delete $draftdir ;;
- -r*) listposts $blogdir && $EDITOR $blogdir/$blogpost.html ;;
- -c*) listposts $blogdir && title_change ;;
- -o*) listposts $blogdir && $BROWSER $blogdir/$blogpost.html ;;
- -d*) listposts $blogdir && delete $blogdir ;;
- -l*) listposts $blogdir ;;
+ -p*) listposts $DRAFTDIR && publish ;;
+ -e*) listposts $DRAFTDIR && $EDITOR $DRAFTDIR/$blogpost.html ;;
+ -v*) listposts $DRAFTDIR && view ;;
+ -t*) listposts $DRAFTDIR && delete $DRAFTDIR ;;
+ -r*) listposts $BLOGDIR && $EDITOR $BLOGDIR/$blogpost.html ;;
+ -c*) listposts $BLOGDIR && title_change ;;
+ -o*) listposts $BLOGDIR && $BROWSER $BLOGDIR/$blogpost.html ;;
+ -d*) listposts $BLOGDIR && delete $BLOGDIR ;;
+ -l*) listposts $BLOGDIR ;;
*) usage ;;
esac
}
-# TODO: list only html maybe
list() {
- find $1 -type f ! -name '*final*' 2> /dev/null | awk -F/ '{print $NF}'
+ find $1 -type f -name '*\.html' ! -name '*final*' 2> /dev/null | awk -F/ '{print $NF}'
}
listposts() {
@@ -48,14 +47,14 @@ listposts() {
}
newpost() {
- mkdir -p $draftdir
+ mkdir -p $DRAFTDIR
read -erp "Title: " title && [ -z "$title" ] &&
echo "Please specify a title." && exit
blogpost=$(title_fmt "$title")
- [ -f "$blogdir/$blogpost.html" ] && echo "File exists already." && exit
- $EDITOR "$draftdir/$blogpost.html"
- sed "s/TITLE/$title/g;s/HEADER/$title/g;s/AUTHOR/$author/g;" $template \
- > $draftdir/$blogpost.final.html
+ [ -f "$BLOGDIR/$blogpost.html" ] && echo "File exists already." && exit
+ $EDITOR "$DRAFTDIR/$blogpost.html"
+ sed "s/TITLE/$title/g;s/HEADER/$title/g;s/AUTHOR/$AUTHOR/g;" $TEMPLATE \
+ > $DRAFTDIR/$blogpost.final.html
}
confirm_action() {
@@ -63,7 +62,7 @@ confirm_action() {
}
psed() {
- sed -i.orig "$@" && rm *.orig $blogdir/*.orig 2> /dev/null
+ sed -i.orig "$@" && rm *.orig $BLOGDIR/*.orig 2> /dev/null
}
title_fmt() {
@@ -77,34 +76,34 @@ title_get() {
publish() {
confirm_action "Publish post (y/N)? " "y"
- title=$(title_get $draftdir/$blogpost.final.html)
- psed "s/^/\ \ \ \ \ \ \ \ /" $draftdir/$blogpost.html # bad?
- psed "/<\!--BLOG-->/r $draftdir/$blogpost.html" $draftdir/$blogpost.final.html
- sed "s/</\</g;s/>/\>/g;" "$draftdir/$blogpost.html" > $draftdir/$blogpost.xml
- cp $draftdir/$blogpost.final.html $blogdir &&
- mv $blogdir/$blogpost.final.html $blogdir/$blogpost.html
+ title=$(title_get $DRAFTDIR/$blogpost.final.html)
+ psed "s/^/\ \ \ \ \ \ \ \ /" $DRAFTDIR/$blogpost.html # bad?
+ psed "/<\!--BLOG-->/r $DRAFTDIR/$blogpost.html" $DRAFTDIR/$blogpost.final.html
+ sed "s/</\</g;s/>/\>/g;" "$DRAFTDIR/$blogpost.html" > $DRAFTDIR/$blogpost.xml
+ cp $DRAFTDIR/$blogpost.final.html $BLOGDIR &&
+ mv $BLOGDIR/$blogpost.final.html $BLOGDIR/$blogpost.html
- printf "\t\t\t\t<li>%s – <a href=\"%s\">%s</a></li>\n" \
- "$(date '+%Y %b %d')" "$blogdir/$blogpost.html" "$title" | \
- expand -t4 > $draftdir/$blogpost.final-htmlentry
+ printf "\t\t<li>%s – <a href=\"%s\">%s</a></li>\n" \
+ "$(date '+%Y %b %d')" "$BLOGDIR/$blogpost.html" "$title" | \
+ expand -t8 > $DRAFTDIR/$blogpost.final-htmlentry
- printf "<item>\n\t<title>%s</title>\n\t<guid>%s</guid>\n\t<pubDate>%s</pubDate>\n\t<description>\n\t\t%s\n \t</description>\n</item>\n" "$title" "$website/$blogdir/$blogpost.html" "$(date '+%a, %d %b %Y')" "$(cat $draftdir/$blogpost.xml)" | expand -t4 > $draftdir/$blogpost.final-rssentry
+ printf "<item>\n\t<title>%s</title>\n\t<guid>%s</guid>\n\t<pubDate>%s</pubDate>\n\t<description>\n\t%s\n\t</description>\n</item>\n" "$title" "$WEBSITE/$BLOGDIR/$blogpost.html" "$(date '+%a, %d %b %Y')" "$(cat $DRAFTDIR/$blogpost.xml)" | expand -t8 > $DRAFTDIR/$blogpost.final-rssentry
# using || because of psed
blogindex_update
- psed "/<\!--BLOG $(date '+%B %Y')-->/r $draftdir/$blogpost.final-htmlentry" $blogindex ||
+ psed "/<\!--BLOG $(date '+%B %Y')-->/r $DRAFTDIR/$blogpost.final-htmlentry" $BLOGINDEX ||
echo "Blogindex... done."
- psed "/<\!--BLOG-->/r $draftdir/$blogpost.final-htmlentry" $index || echo "Index... done"
- psed "/<\!--BLOG-->/r $draftdir/$blogpost.final-rssentry" $rssfile || echo "RSS... done"
+ psed "/<\!--BLOG-->/r $DRAFTDIR/$blogpost.final-htmlentry" $INDEX || echo "Index... done"
+ psed "/<\!--BLOG-->/r $DRAFTDIR/$blogpost.final-rssentry" $RSSFILE || echo "RSS... done"
remove_last_index_entry || echo "Removing last entry from index file... done"
- remove_contents $draftdir && echo "Cleaning up .drafts... done"
+ remove_contents $DRAFTDIR && echo "Cleaning up $DRAFTDIR... done"
echo "Published $blogpost."
}
-#TODO: i dont like how this looks...
+#TODO: i dont like how this looks... also needs portable solution
blogindex_update() {
dateid=$(date '+%b %Y' | sed 's/\ //' | tr '[:upper:]' '[:lower:]')
- if [ -z "$(grep "$dateid" $blogindex)" ]; then
+ if [ -z "$(grep "$dateid" $BLOGINDEX)" ]; then
datename=$(date '+%B %Y')
monthheader=$(
printf "\\
@@ -112,26 +111,28 @@ blogindex_update() {
<ul> \\
\t<\!--BLOG %s--> \\
<\/ul>" \
- "$dateid" "$datename" "$datename" | sed 's/^/\t\t\t/' | expand -t4
+ "$dateid" "$datename" "$datename" | sed "s/^/ /" | expand -t8
)
- psed "/<\!--BLOG-->/a $monthheader" $blogindex
+ echo "$monthheader"
+ # WTF is going wrong
+ sed "/<\!--BLOG-->/a $monthheader" $BLOGINDEX
fi
}
remove_last_index_entry() {
- indexentries=$(sed "1,/<\!--BLOG-->/d" $index | grep "<li>") &&
+ indexentries=$(sed "1,/<\!--BLOG-->/d" $INDEX | grep "<li>") &&
[ $(expr $(echo "$indexentries" | wc -l)) -gt 7 ] &&
lastentry=$(echo "$indexentries" | tail -2 | head -1) &&
- psed "s|$lastentry||;" $index
+ psed "s|$lastentry||;" $INDEX
}
delete() {
confirm_action "Are you sure you want to delete \"$blogpost\" (y/N)? " "y"
- if [ "$1" = "$blogdir" ]; then
- psed "/$blogpost/d" $index $blogindex
+ if [ "$1" = "$BLOGDIR" ]; then
+ psed "/$blogpost/d" $INDEX $BLOGINDEX
# TODO: make portable
- gsed -ni "/<item>/{ :loop; N; s/<\\/item>/&/; T loop; s/$blogpost/&/; T keep; d }; :keep; p" $rssfile
+ gsed -ni "/<item>/{ :loop; N; s/<\\/item>/&/; T loop; s/$blogpost/&/; T keep; d }; :keep; p" $RSSFILE
fi
remove_contents $1 && echo "Removed $blogpost."
}
@@ -141,22 +142,22 @@ remove_contents() {
}
view() {
- cat $draftdir/$blogpost.final.html > $draftdir/$blogpost.final-view.html
- title=$(title_get $draftdir/$blogpost.final-view.html)
- psed "/<\!--BLOG-->/r $draftdir/$blogpost.html" $draftdir/$blogpost.final-view.html
- $BROWSER $draftdir/$blogpost.final-view.html
+ cat $DRAFTDIR/$blogpost.final.html > $DRAFTDIR/$blogpost.final-view.html
+ title=$(title_get $DRAFTDIR/$blogpost.final-view.html)
+ psed "/<\!--BLOG-->/r $DRAFTDIR/$blogpost.html" $DRAFTDIR/$blogpost.final-view.html
+ $BROWSER $DRAFTDIR/$blogpost.final-view.html
}
title_change() {
read -erp "Give post a new title: " newtitle && \
confirm_action "Are you sure (y/N)? " "y"
- oldtitle=$(title_get $blogdir/$blogpost.html)
+ oldtitle=$(title_get $BLOGDIR/$blogpost.html)
newtitle_fmt=$(title_fmt "$newtitle")
- [ -f "$blogdir/$newtitle_fmt.html" ] && echo "File exists already." && exit
+ [ -f "$BLOGDIR/$newtitle_fmt.html" ] && echo "File exists already." && exit
psed "s/$blogpost/$newtitle_fmt/g;s/$oldtitle/$newtitle/g" \
- $blogdir/$blogpost.html $index $blogindex $rssfile &&
- mv $blogdir/$blogpost.html $blogdir/$newtitle_fmt.html &&
+ $BLOGDIR/$blogpost.html $INDEX $BLOGINDEX $RSSFILE &&
+ mv $BLOGDIR/$blogpost.html $BLOGDIR/$newtitle_fmt.html &&
echo "Title changed successfully: $oldtitle -> $newtitle"
}
@@ -167,15 +168,15 @@ err() {
missing_check() {
missing=false
- [ -f "$template" ] || err $template
- [ -f "$index" ] || err $index
- [ -f "$rssfile" ] || err $rssfile
- [ -f "$blogindex" ] || err $blogindex
+ [ -f "$TEMPLATE" ] || err $TEMPLATE
+ [ -f "$INDEX" ] || err $INDEX
+ [ -f "$RSSFILE" ] || err $RSSFILE
+ [ -f "$BLOGINDEX" ] || err $BLOGINDEX
[ "$missing" = "true" ] && exit
- [ ! -d "$blogdir" ] &&
+ [ ! -d "$BLOGDIR" ] &&
confirm_action "Blog directory doesn't exist. Intialize it here (y/n)? " "y" &&
- mkdir -pv $blogdir
+ mkdir -pv $BLOGDIR
}
usage() {
diff --git a/sbrs.1 b/sbrs.1
@@ -67,9 +67,9 @@ The TITLE, HEADER and AUTHOR fields must exist and be left as is.
The RSS feed.
.El
.Pp
+Inside the files mentioned above
.Nm
-will search for <!--BLOG--> inside index.html and rss.xml
-in order to put the blog post listings and RSS feed respectively. Inside blogindex.html
-however, it will search for <!--BLOG [Month Year]--> (e.g <!--BLOG January 1800->).
+will search for <!--BLOG--> in order to put the appropriate blog contents.
+These comments should not be edited or removed.
.Sh AUTHORS
.An Christos Margiolis Aq Mt christos@christosmarg.xyz
diff --git a/styles.css b/styles.css
@@ -1,21 +1,16 @@
html {
- max-width: 1050px;
- margin-left: auto;
- margin-right: auto;
- margin-top: 30px;
- color: #333;
- padding-bottom: 200px;
- }
+ max-width: 1050px;
+ margin-left: auto;
+ margin-right: auto;
+ margin-top: 30px;
+ color: #333;
+ padding-bottom: 200px;
+}
-a {color: royalblue; }
-a:hover {color: lightblue; }
+a {
+ color: royalblue;
+}
-.entry {
- border-left: 10px solid darkslategray;
- padding: 0px 10px 0px 10px;
- border-radius: 0 30px 30px 0;
- margin-bottom: 20px;
- background-color: #eee;
- }
-
-.entry h2 { margin: 5px auto 2px auto; }
+a:hover {
+ color: lightblue;
+}
diff --git a/template.html b/template.html
@@ -1,16 +1,16 @@
<!DOCTYPE html>
<html>
- <head>
+<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="../styles.css"/>
<title>TITLE</title>
- </head>
+</head>
- <body>
+<body>
<h1>HEADER<h1>
<!--BLOG-->
- <center>by <a href="../index.html">AUTHOR</a></center>
- </body>
+ <footer>by <a href="../index.html">AUTHOR</a></footer>
+</body>
</html>
