This is an internal page that contains information on the Sandpoints infrastructure.
---
[Hugo]: https://gohugo.io/ "Hugo is a free and open source static website builder."
For Sandpoints in general see .
# Sandpoints general
Hugo is a framework for generating lightweight static websites. Content is created via Markdown files and requires no programming. It makes use of simple terminal commands for creating content, generating and publishing a website.
*Sandpoints* functions as a theme for [Hugo][], which adds additional functionality catered to open publishing. Sandpoints as a Hugo theme/module:
- adds hypertext functionality, with backlinks.
- can include a project related , and content can link to library entries.
- can generate  for its content. This, for single entries, for grouped entries (issue of contributions), or for all content. PDFs containing more than one entry include a table of contents.
# Clone & run locally
Preparations:
- install Hugo (see [Hugo installation](https://gohugo.io/installation/))
- install the [Go Language](https://go.dev/).
- install [Git](https://git-scm.com/).
- clone this repository.
To run this site locally:
- open a terminal, and navigate to the root folder of this project (which includes the folder `content`).
- to run a local dynamic server with the project, run:
> `hugo server`
- to do the same and include drafts, run:
>`hugo server -D`
- to compile the site, run:
> `hugo`
- to compile the website and include drafts, run
> `hugo -D`
# Upgrading Sandpoints
1. Upgrade *Hugo*.
- For Windows, if *Hugo* was installed with the `choco` package manager, open a terminal as administrator and run:
> `choco upgrade hugo`
- For OSX, if *Hugo* was installed with the `homebrew` package manager, open a terminal and run:
> `brew upgrade hugo`
2. To check the version of your *Hugo* installation, run:
> `hugo version`
3. To update *Sandpoints*, navigate to the root folder of the project and run the following two commands, one at a time:
> `hugo mod get`
> `hugo mod vendor`
# Library integration
*Sandpoints* features a project-based library using the infrastructure of [Memory of the World](https://library.memoryoftheworld.org/) library.
You can access the project library by clicking the red button at the top right corner of the website.
Libraries are created using the open source e-book management software [Calibre](https://calibre-ebook.com/), and managed using the command line tool [Accorder](https://pypi.org/project/accorder/).
# Notes
- For an extended description of *Sandpoints* see [Sandpoints Portfolio (sandpoints.org)](https://pages.sandpoints.org/sandpoints/simplesandpoints-de47f813/draft/portfolio/), which includes descriptions of its implementation in different projects, and related bibliography.
- Graziano, Valeria, Marcell Mars, and Medak Tomislav. ‘Learning from \#Syllabus’. In _State Machines: Reflections and Actions at the Edge of Digital Citizenship, Finance, and Art_, edited by Yiannis Colakides, Marc Garrrett, and Inte Gloerich. Amsterdam: Institute of Network Cultures, 2019. [http://www.statemachines.eu/books/state-machines-reflections-and-actions-at-the-edge-of-digital-citizenship-finance-and-art/](http://www.statemachines.eu/books/state-machines-reflections-and-actions-at-the-edge-of-digital-citizenship-finance-and-art/).
