README.md 4.6 KB

Wat?

Welcome to the past. Welcome to my hacked up re-use of good ol' nanoblogger. The original readme content is below but let me be a bit less professional about things.

If you're reading this, you've stumbled upon my personal fork of nanoblogger. This is mostly out in the public because the old code is under the GPL2 and publishing the code covers most of my obligations there. (All new code, incidentially, is 0BSD but I can't relicense old code that isn't mine. So, here we are.)

Upfront, let me say that this is a personal project and not for you. I'm not taking pull requests or bug reports. I want this shit to work for my sites and that's it. You too can unpack the 3.5-RC1 tarball and hack on it if you want. Or clone this and hack away. No me importa.

But you're still 'wat' about this code aren't you?

Here in the grand 2020s, static site generators are all the rage. They're huge and complicated and do all manner of things. That's great. Until recently, I was using one. I'm an ... infrequent blogger and pretty much every time I sat down to write, a site generator update would fuck up my day and I'd spend time fixing the thing rather than writing. "Infrequent" becomes "never" when I'm certain that every attempt will result in panic coding not writing.

So, what do? Write my own thing from scratch? I could but that's a lot more coding. Then I remembered nanoblogger. In the early 00s, my site was nanoblogger and shit just worked. And you know what? It's abandoned. Has been for nearly a decade now. There are no upstream developers who are going to fuck with me. And this code? This is an evil bash script that works in pretty much any POSIX environment. It just works out of the box. I copied some posts in from my other site and bam! a very 00s aesthetic site.

There are some tweaks. I brought in a kramdown based markdown bit so I could get GFM support. I'm sure I will hack on other things later.

If nothing else, celebrate that it is possible to write code that still works out of the box in a modern environment a decade after being abandoned. Maybe learn from that and take that into your own coding practice. Or not. Probably not. It doesn't pay to write code that just works for decades with no modifications. Anyway! This isn't for you but if it's useful to you, awesome.

Kevin's original README follows and is way more professional than I am.

The Original README

# Last modified: 2008-09-11T22:14:32-04:00

NanoBlogger is a small weblog engine written in Bash for the command
line. It uses common UNIX tools such as cat, grep, and sed to create
static HTML content.

Installing NanoBlogger
----------------------

1. download gzipped tarball:
   http://nanoblogger.sourceforge.net/downloads/nanoblogger-xx.tar.gz
2. decompress gzipped tarball: tar xzf nanoblogger-xx.tar.gz
3. Modify shell's path to include the installation path.[1]

   NOTE: this step will be taken care for you when you install through a
         package manager, like apt-get.

Generic Upgrade Instructions
----------------------------

Follow these three steps:

1. create a new weblog directory using nanoblogger (skip the
   configuration):
	nb --interactive 0 -b [new-blog-dir] add weblog

2. copy the old data directory over to the new weblog directory:
	cp -r [old-blog-dir]/data [new-blog-dir]

3. edit the new blog.conf to your likings and rebuild
   the weblog:
	nb -b [new-blog-dir] configure update all

Upgrade Notes
-------------

### Style Sheets & Templates ###
 
In addition to your *old* data directory, you will probably want to also
copy over your styles and templates directory. If you decide to do this,
you may find that your style sheets or templates no longer work as
expected. In which case some adjustments will have to be made before
they work properly with the new version. A side-by-side comparison
between the old and new version will be your best recourse. Consider
this a small trade-off for the ability to fully customize the weblog's
appearance.

### Configuration ###

Similarly, you will probably want to keep many settings from your old
blog.conf. In which case, I suggest you do a side-by-side comparison of
your old blog.conf and the new blog.conf. Then manually migrate your
settings over to the new blog.conf.

### Plugins ###

If you created your own plugins, please take into account any changes to
variables, settings, etc., that your plugins may depend on.

Final Notes
-----------

For more in depth documentation please see the
[NanoBlogger User Manual](nanoblogger.html) which should've been
included with your copy of NanoBlogger.

Project Page: http://nanoblogger.sourceforge.net
Mailing List: http://groups.yahoo.com/group/nanoblogger