version 0.3
fixes: - fixed the mess of options and general inconsistencies between program man page and help message - fixed some cases where rivet should fail but didn't and specified return values for all exit conditions - fixed the header system, before the header would have been added inside of <head></head> which is incorrect, browsers would fix it on the fly but still it is not correct. Now _header.html contents are put inside <header></header> at the beginning of <body> - fixed <footer> outside of <body> - some fixes in the man page additions: - added the requirement for _metadata.html, this file contains tags and html metadata that is put inside <head> - the main article is now enclosed inside <article></article> tags for better styling
This commit is contained in:
parent
5ac9e2ae5f
commit
280d0946db
3 changed files with 71 additions and 28 deletions
22
rivet.1
22
rivet.1
|
|
@ -5,10 +5,12 @@ rivet \- simple static site generator
|
|||
|
||||
.SH SYNOPSIS
|
||||
.SY rivet
|
||||
.OP \-vhelfsu
|
||||
.OP \-hvelfsurdt
|
||||
.OP \-o destdir
|
||||
.OP \-p string
|
||||
.I srcdir/
|
||||
.OP \-m number
|
||||
.OP \-n string
|
||||
.I srcdir
|
||||
.I domain
|
||||
.YS
|
||||
|
||||
|
|
@ -16,7 +18,7 @@ rivet \- simple static site generator
|
|||
.PP
|
||||
Rivet is a POSIX shell script that relies on
|
||||
.BR lowdown(1)
|
||||
to convert markdown ( refer to
|
||||
to convert markdown (refer to
|
||||
.BR lowdown(5)
|
||||
for more info on the dialect of markdown used and metadata) files to html and
|
||||
build an output directory which can be uploaded to an http server.
|
||||
|
|
@ -48,7 +50,7 @@ Set the title of the atom feed to
|
|||
.IP "\-d string"
|
||||
Set the description of the atom feed to
|
||||
.I string
|
||||
.IP "\-n number"
|
||||
.IP "\-m number"
|
||||
Set the maximum number of elements in the atom feed to
|
||||
.I number
|
||||
setting it to '0' includes all files
|
||||
|
|
@ -62,6 +64,9 @@ Disables the application of the user-supplied header in
|
|||
.IP \-f
|
||||
Disables the application of the user-supplied footer in
|
||||
.I _footer.html
|
||||
.IP \-t
|
||||
Disables the insertion of the user-supplied metadata in
|
||||
.I _metadata.html
|
||||
.IP \-l
|
||||
Disables the generation of the "Pages" section in index.html
|
||||
.IP \-s
|
||||
|
|
@ -95,6 +100,7 @@ src/
|
|||
- index.md
|
||||
- _header.html
|
||||
- _footer.html
|
||||
- _metadata.html
|
||||
.EE
|
||||
|
||||
.PP
|
||||
|
|
@ -110,6 +116,8 @@ contains
|
|||
.EX
|
||||
<p> Header </p>
|
||||
.EE
|
||||
.I _metadata.html
|
||||
can be empty
|
||||
|
||||
.PP
|
||||
Note that since the contents of
|
||||
|
|
@ -119,6 +127,12 @@ and
|
|||
will be placed inside the correct tags, the files themselves do not need to
|
||||
contain <header> and <footer> tags (the script removes them)
|
||||
|
||||
.PP
|
||||
The contents of
|
||||
.I _metadata.html
|
||||
are placed inside the <head> tags, so it can contain stylesheets, icons and
|
||||
other valid entries for the head of an html document
|
||||
|
||||
.PP
|
||||
To generate the site from the folder run the command
|
||||
.EX
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue