This book provides a basic introduction to installation, configuration and customization of the open source discovery software, VuFind®.
For more information on VuFind®, please visit: https://www.vufind.org
For locally building the documentation you need the Sphinx documentation generator: https://www.sphinx-doc.org
Please refer to the official Sphinx documentation on how to install on your system.
After having installed Sphinx on your system first clone the learning-vufind-book
into your workdingdir
$ git clone https://github.com/vufind-org/learning-vufind-book.git
change directory
$ cd learning-vufind-book
and build the Learning VuFind® Book
$ make html
When build process is finished you will find the built html-files in ./build/html
. To view the built documentation open ./build/html/index.html
.
If you prefer a PDF version, you can instead run
$ make latexpdf
If you prefer an ePub version, you can run
$ make epub
If you prefer a single-file HTML version (which is useful for conversion to Microsoft Word format), you can run
$ make singlehtml
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.