-
Notifications
You must be signed in to change notification settings - Fork 0
/
sitesync.1
66 lines (66 loc) · 2.33 KB
/
sitesync.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
.\" Automatically generated by Pandoc 2.14.1
.\"
.TH "MS" "1" "December 2021" "ms 1.0.3" ""
.hy
.SH NAME
.PP
sitesync - a simple static-site generation shell script
.SH SYNOPSIS
.PP
\f[B]sitesync\f[R] [\f[I]OPTION\f[R]] [\f[I]TARGET\f[R]]
.SH DESCRIPTION
.PP
\f[B]sitesync\f[R] compiles a website\[cq]s page content into a
fully-functioning webpages based off of a user supplied template.
.SH OPTIONS
.TP
\f[B]build\f[R]
builds a local version of the website, saved in the website\[cq]s
\[lq]local\[rq] folder
.TP
\f[B]deploy\f[R]
builds the website into the \[lq]public\[rq] directory where the
directory is then mirrored to wherever it is served from.
This can be synced to a VPS, or pushed to a Git provider that serves
from the site\[cq]s repository.
.TP
\f[B]init\f[R]
creates a new website directory with the name of the argument following
\f[B]init\f[R].
The directory contains \[lq]assets\[rq], \[lq]local\[rq],
\[lq]public\[rq], and \[lq]content\[rq] directories.
.SH EXAMPLES
.TP
\f[B]sitesync init example\f[R]
Creates a website directory titled \[lq]example\[rq] in the current
directory, with the following directories and files: * assets/ -
styles.css - template.html * content/ - index.md - blog.html - blog/ *
example.html * local/ * public/
.TP
\f[B]sitesync build path/to/example\f[R]
Builds a local version of the website (with the proper directory
structure) into the \[lq]local\[rq] folder.
If the website features no Javascript (is just HTML, CSS, and local
files) the local version of the site can be viewed at
\f[I]file:///absolute/path/to/local/folder/file.html\f[R].
.TP
\f[B]sitesync deploy path/to/example\f[R]
the deploy command builds the website into the \[lq]public\[rq]
directory and then can mirror the website to where it is served with the
deploy command defined in the
\[lq]$XDG_CONFIG_HOME\[rq]/sitesync/example\[rq] file.
.SH BUGS
.PP
This script requires the basic directory structure provided by the
\f[B]init\f[R] command.
The script will also not correct absolute file paths to the root of the
site deeper than 3 directories from the site root
(e.g.\ root/subdir/anothersubdir/file.html would work).
.SH COPYRIGHT
.PP
This is free software provided under the GPLv3 license.
You are free to change and distribute this software, so long as it
remains free software.
There is no warranty, to the extent permitted by law.
.SH AUTHORS
Jake VanderVaate.