~rjpcasalino/bss

e98009e836ed4b1864c7b67bd40e701312358468 — rjpc 2 months ago 6de4ef6 + cd8c9fa trunk
Merge branch 'trunk' of git.sr.ht:~rjpcasalino/bss into trunk
2 files changed, 9 insertions(+), 26 deletions(-)

M README.md
D shell.nix
M README.md => README.md +9 -12
@@ 2,13 2,12 @@

# bss - boring static site generator

A dead simple static site generator written in Perl with a little help from rsync.
A boring (and simple...) static site generator written in Perl with a little help from rsync.

## Getting Started

	bss reads manifest.ini for its configuration options:

	```
bss reads manifest.ini for its configuration options:
	
	[build]
	src=/the/path/to/your/site/src/
	dest=/home/you/websites/_site/


@@ 19,11 18,8 @@ A dead simple static site generator written in Perl with a little help from rsyn
	[server]
	port=8090

	```

	Pages begin (as in Jekyll) with a YAML "front matter" block:  
Pages begin (as in Jekyll) with a YAML "front matter" block:  

	```
	---
	title: Nine Stories
	layout: default 


@@ 31,11 27,11 @@ A dead simple static site generator written in Perl with a little help from rsyn
	---
	[% footer = 'partials/footer.tt' %]

		foot clan
		A Perfect Day for Bananafish wherein Seymour ends his own life...

	[% INCLUDE $footer %]
	```

	Template files can use any of the following file exts: `.tmpl, .template, .html, .tt, .tt2`.
Template file types can be any of: `.tmpl, .template, .html, .tt, .tt2`.

A simple web server is included but one would be wise in using it only for local development purposes.
Ensure the `BSS_DOCROOT` ENV var is set.


@@ 47,7 43,8 @@ $ BSS_DOCROOT=/path/to/your/_site bss build --server
```

## FIXME
- [] rsync: --info=NONE: unknown option on Darwin
- [] BSS_DOCROOT should set to whatever is in config
- [] Handle removing YAML block correctly
- [] So that we can actually write OG daringfireball md
- [] Markdown parser might be garbage 
- [] short flags so we can do -v and -s for verbose and server

D shell.nix => shell.nix +0 -14
@@ 1,14 0,0 @@
{ pkgs ? import <nixpkgs> {}
}:
pkgs.mkShell {
  name = "bss";
  buildInputs = [
    pkgs.perl # important!
    pkgs.perlPackages.PerlTidy
    pkgs.perlPackages.ConfigIniFiles
    pkgs.perlPackages.TextMarkdown 
    pkgs.perlPackages.TemplateToolkit 
    pkgs.perlPackages.YAML
    pkgs.rsync
  ];
}