From a27fa0c2e26eb2e30e220fd68cd5ee910474b602 Mon Sep 17 00:00:00 2001 From: Bradley Taunt Date: Fri, 2 Feb 2024 12:39:46 -0500 Subject: Initial commit to new cgit platform --- index.html | 161 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 161 insertions(+) create mode 100644 index.html (limited to 'index.html') diff --git a/index.html b/index.html new file mode 100644 index 0000000..bded92d --- /dev/null +++ b/index.html @@ -0,0 +1,161 @@ + + +Shinobi Website | A text-based, RSS focused blogging "system"
   ______ _______  ______  ___  ____
+  / __/ // /  _/ |/ / __ \/ _ )/  _/
+ _\ \/ _  // //    / /_/ / _  |/ /
+/___/_//_/___/_/|_/\____/____/___/
+
+       /\
+,vvvvvvv\\-------------------------,
+`^^^^^^^//========================"
+       \/
+
+
+WHAT IS A SHINOBI WEBSITE?
+==========================
+
+A shinobi website is a text-based, RSS focused blogging "system". I put
+the word system in quotes since it's really just a simple bash script
+that converts plain text files into an RSS feed. So, it isn't an actual
+blogging platform or website in the traditional sense.
+
+Why the name "shinobi"? Well, a shinobi was a covert agent or mercenary
+during the time of feudal Japan. Due to their focus on infiltration and
+assassination, they required a strong focus on stealth and being unseen.
+
+A shinobi website follows the same principles of being secretive and
+unseen (minus the assassinations and espionage). Only those who
+*choose* to include your feed in their respective RSS readers can view
+your content via the included URL.
+
+It's like an exclusive club[0] for your true, real audience.
+
+
+A SHINOBI WEBSITE IS PURE MINIMALISM
+------------------------------------
+
+Imagine writing *just* content. No dependencies. No heavy-duty build
+process. Nothing but simple plain text files. One bare-bones bash
+script is all you need to generate a valid RSS file from your existing
+text files.
+
+This concept isn't anything new. In fact, this entire project was
+greatly influenced by WRITING FOR THE INTERNET ACROSS A HUMAN
+LIFETIME[1]
+
+
+CREATE YOUR OWN
+---------------
+
+1. Simply clone/download the project below
+2. Make sure you edit the parameters at the top of the script.sh (in
+your favorite text editor)
+
+```shell
+#!/bin/sh
+DOMAIN="YOUR-DOMAIN"
+POST_DIR="posts/"
+AUTHOR="YOUR-EMAIL (YOUR-NAME)"
+TIME="00:00:00 EST"
+```
+
+3. Write your posts/pages as plain text files (.txt) inside a
+sub-folder (/posts)
+4. Run the `make` in you terminal when a new post/page is added
+5. (Optional) Run `make serve` to test your changes locally
+6. Update your site files and RSS feed to your web server
+7. Profit!
+
+
+THE CODE
+--------
+
+I hardly consider myself a hardcore "developer" (I'm actually a UI
+designer - if you can believe it!) so please go easy on judging my ugly
+coding skills. It gets the job done quickly and renders valid RSS
+syntax. That's all that matters.
+
+You can find the very basic project code on sourcehut (licensed under
+MIT):
+
+https://git.btxx.org/shinobi
+
+
+WRITING A POST OR PAGE
+----------------------
+
+There are only a few minor caveats you need to be aware of when writing
+your plain text files. If you have the technical skills, you have the
+freedom to change these settings within the script.sh file itself.
+
+1. The first line of each text file needs to be the post's date
+2. The second line of each text file needs to be the post's title
+3. The third line of each text file needs to be blank
+4. The fourth line of each text file needs to be the post's description
+
+Example:
+
+01| Wed, 13 Dec 2045
+02| MY AMAZING BLOG POST FROM THE FUTURE
+03|
+04| This blog post is ahead of its time
+
+That's it. The script will take care of everything and render things
+perfectly for most RSS readers.
+
+
+READ THE OFFICIAL SHINOBI.WEBSITE
+---------------------------------
+
+Simply add:
+
+
https://shinobi.btxx.org/feed.xml
+
+to your RSS reader of choice. For Apple devices, I strongly recommend
+using the NetNewsWire[2] family of applications. For those on other
+platforms I would recommend the web-based application Feedly.
+
+
+ARTICLES
+--------
+
Tue, 14 Jun 2022 08:40:17 EDT
INTERACTIVE LINKS INSIDE XML FEEDS
https://shinobi.btxx.org/posts/patch-3.txt
Tue, 31 May 2022 08:40:17 EDT
CUSTOMIZED RSS FEED WITH XSLT
https://shinobi.btxx.org/posts/patch-2.txt
Sun, 15 May 2022 08:40:17 EDT
FIRST MAJOR PATCH AND QOL IMPROVEMENTS
https://shinobi.btxx.org/posts/patch-1.txt
Mon, 09 May 2022 08:40:17 EDT
THE SHINOBI SCRIPT IS NOW AVAILABLE ON SOURCEHUT
https://shinobi.btxx.org/posts/shinobi-sourcehut.txt
Fri, 06 May 2022 08:40:17 EDT
FULL POSTS ARE NOW RENDERED INSIDE RSS READERS
https://shinobi.btxx.org/posts/full-posts-rss-readers.txt
Thu, 21 Apr 2022 08:40:17 EDT
SIMPLE GUIDE FOR CREATING YOUR OWN SHINOBI.WEBSITE
https://shinobi.btxx.org/posts/create-your-own-shinobi-website.txt
Thu, 14 Apr 2022 08:40:17 EDT
INTRODUCING SHINOBI.WEBSITE
https://shinobi.btxx.org/posts/introducing-shinobi-website.txt
+
+Articles posted here will mostly cover updates and patch notes for
+all things Shinobi. Following this feed is a good way to stay up-to-date.
+
+
+HELP BY CONTRIBUTING!
+---------------------
+
+I am far from a good developer, so my code is most likely lacking.
+Please don't hesitate to submit patches or suggest changes below:
+
+
https://git.btxx.org/shinobi
+
+
+FOOTNOTES
+---------
+[0]: https://daverupert.com/rss-club/
+[1]:http://len.falken.directory/misc/writing-for-the-internet-across-a-human-lifetime.txt
+[2]: https://netnewswire.com
+
+
+Thanks for reading,
+-- Brad
+
+
+
-- cgit v1.2.3-54-g00ecf