shite

rc static blog generator
git clone git://git.2f30.org/shite
Log | Files | Refs | README

README (1237B)


      1 shite
      2 An rc shtatic html/gemini blog generator.
      3 
      4 Usage:
      5  ./shite {init, mk, clean}
      6 
      7 Tune the baseurl, blogtitle, css variables in
      8 the shite script, and modify postdb and content/
      9 with the data you want to serve.
     10 
     11 This script reads a postdb file formatted as per ndb(6).  It then
     12 creates indexing files that associate the fields.  
     13 These files are used in automatically creating post navigation
     14 pages by id and tag, as well as a navbar
     15 
     16 An example postdb file contains entries like
     17 
     18 type=post
     19 	id=1
     20 	title="a test title"
     21 	date=2021-04-15
     22 	tag=tag1 tag=tag2
     23 	content="content/post-test"
     24 
     25 type=page
     26 	title="home"
     27 	content="content/home"
     28 
     29 It describes a site consisting of a home page, a blog
     30 page that contains one entry, as well as navigation pages
     31 based on post titles and tags.
     32 
     33 The files it would create in the current directory are
     34 ids, tags, titles, id_content, id_title, tag_id, title_content
     35 
     36 content files should be plain text as they are just appended
     37 between hardcoded headers and footers.
     38 
     39 Depending on the setting the HTML_BASE and/or GEMINI_BASE
     40 variables in the mkshite script it generates under publish/
     41 the final static sites that you can upload to your web/gem
     42 servers.
     43 
     44 All code is Public Domain.
     45 DsP <dsp 47 2f30.org>
     46 
     47