r1k
/
lb
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

readme updates

This commit is contained in:
Luke Smith 2018-08-29 00:29:57 -04:00
parent 0ba518a84c
commit 010f65edd6
1 changed files with 34 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -4,11 +4,21 @@ Blogs and RSS feeds in less than 100 lines of shell script. `lb` stands for wha
## Features
+ Create and publish blog posts for your website. The intended format is for all posts to appear in a rolling blog post. See [https://lukesmith.xyz/2018.html](https://lukesmith.xyz/2018.html) for an example.
+ Custom links are generated for these entries in the form of [standalone files](https://lukesmith.xyz/blog/) and links to the headings of each blog post so you can link people to specific blog posts on the rolling blog.
+ Blog posts are automatically added to your RSS feed when finalized.
+ One command to delete published entries from the RSS feed, rolling blog and standalone entries simultaneously.
+ Posts in the rolling blog have divs that can easily be modified via a CSS stylesheet.
`lb` is an extremely small shell script that lets you write blog posts and will
format them in all the ways you could ever want. Here's what it will produce:
- A Rolling Blog Page. See [my own Rolling Page](https://lukesmith.xyz/blog.html) as an example.
- A list of all blog entries with dates: [Blog List File](https://lukesmith.xyz/blogindex.html). (Note that my earlier entries
lack the date as they were added before I added this feature.)
- All your blog posts appear as standalone entries/pages, for example [like this one](https://lukesmith.xyz/blog/the-real-bronze-age-mindset.html).
- These standalone files exist in a `blog/` directory, which you can allow to
be browsed manually via your Apache web server as I have
[here](http://lukesmith.xyz/blog).
- Blog posts are added, in full form, to an RSS feed of your chosing as well,
see [my RSS feed](https://lukesmith.xyz/rss.xml).
- Posts in the rolling blog have divs that can easily be modified via a CSS
stylesheet, and in general everything is easily editable.
- One command to delete published entries from the RSS feed, rolling blog and standalone entries simultaneously.
## Usage
@ -16,29 +26,43 @@ Blogs and RSS feeds in less than 100 lines of shell script. `lb` stands for wha
./lb new # Make a new blog post draft.
./lb finalize # Finalize/publish a blog post draft.
./lb delete # Delete a published blog post.
./lb discard # Delete a draft of an entry.
```
Finished posts are in `blog/`; Drafts are in `blog/.drafts/`. Use `./lb delete` to remove finished posts, because this command removes the .html files *and* the entries from the RSSfeed and rolling blog.
Use `./lb delete` to remove finished posts, because this command removes the
.html files *and* the entries from the RSSfeed and rolling blog. Don't be
tempted to delete everything manually unless you know what you're doing.
## Installation
+ GNU sed is required.
+ Your `$EDITOR` variable should be set to your preferred text editor.
+ Be sure that you own or have writing privileges in the given directory, so the script can create the required directory structure.
+ Download the `lb` script and put it in your website's home directory. The expectation is that your rolling blog file and RSS feed will be there as well.
+ Download the `lb` script and put it in your website's main directory. The expectation is that your rolling blog file and RSS feed will be there as well.
+ Open the script and change the first few variables to match the files you use in your website.
+ Add markers for where the new blog posts are added. Don't skip this step. See below.
### Markers
For the system to work, add the following comment line where you'd like to both your RSS feed and the HTML file you'd like to use as a rolling blog.
For the system to work, add the following comment line to a (1) Rolling Blog
File (as above), a (2) Blog List File and (3) RSS feed.
```
<!-- LB -->
```
When you `finalize` a blog post, it will be added directly below that line in the proper format (either HTML or the proper RSS/XML format), give you the rolling blog and RSS feed for free.
You can format these files/pages how ever you want, just be sure to edit the
`lb` file and change the variables at the top to match the file names of those
you chose.
When you `finalize` a blog post, it will be added directly below that line in
the proper format (either HTML or the proper RSS/XML format), give you the
rolling blog and RSS feed for free.
## Other stuff
The other files in the repo are an illustration of how the bare bones of the blog can work. The HTML entries create divs with the id "entry", which allows you to modify them with a CSS stylesheet.
The other files in the repo are an illustration of how the bare bones of the
blog can work. The HTML entries create divs with the id "entry", which allows
you to modify them with a CSS stylesheet.
Browse my blog for an idea of how it works (links above).