Using XSite as a standalone application
- Download XSite binary
distribution (xsite-distribution-bin.zip) and unzip archive to local
filesystem directory of your choice.
- Define an environment variable
XSITE_HOME
to
point to the chosen directory.
- Add
XSITE_HOME/bin
to your system path. On UNIX
systems, ensure that you have the correct permissions to execute XSITE_HOME/bin/xsite
(defaults to chmod ug+rwx o+r)
. On Windows systems,
replace /
with \
.
The required inputs for XSite are
- source directory: specifies the root source directory.
- sitemap.xml: specifies the content of the website and the
navigation. The file is assumed to be relative to the source
directory.
- skin.html: specifies the template and style used by XSite.
The file is assumed to be relative to the source directory.
- resources directory: specifies the resources (images, style, etc ...) that need to be
copied to the output directory. The directory is assumed to be relative to the source directory.
- output directory: specifies the directory where the generated
files will be written to.
To generate site, simply execute
xsite -S [source-directory] -m [relative-path-to-sitemap] -s [relative-path-to-skin] -o [output-directory]
Executing script without arguments will also result in a usage message.
Using XSite via plugins
XSite can be used as a plugin as described in plugins.