sqlitebrowser/website

About this repository

This repo contains the source for the sqlitebrowser.org website. It uses CommonMark (also known as Markdown) for the content. It uses Hugo (version 0.111.3) to format the pages. (Note: Earlier versions of this site started to use blogdown, but never embraced it. Vestiges may remain, but are not used.)

There are Dockerfiles for both interactive development and final builds.

Feel free to change things around, and submit PR's as desired.

The license for the DB4S website directory is the same as for DB4S itself: DB Browser for SQLite is bi-licensed under the Mozilla Public License Version 2, as well as the GNU General Public License Version 3 or later.

Editing the site

All the site pages are contained within the /content directory.

Hugo creates its output for the site in the /docs/ directory.

Hugo requires a YAML header to appear above the (standard) Markdown for every page in the site. The minimal header must include a title surrounded by two --- lines. Other useful header lines include:

---
title: Some-title
author: Author-Name
date: "yyyy-mm-dd"
slug: name-to-show-in-the-URL
categories: [comma,separated,categories,"to connect pages"]
tags: [comma,separated,tags]
---

To create a new page, create a Markdown (.md) document using the header above in the proper directory. Name it as desired.

To create a new blog post, create a document named yyyy-mm-dd-subject-of-post.md in the /content/blog directory. Set the proper date in the full header above.

Running in Docker

Docker encapsulates all the necessary tools for running Hugo into a single container without affecting any other software on the host operating system. A Docker container also "locks in" all the versions of the tools so you can be sure that they all work together, and that all your collaborators are always using the same versions of the tool. This is also important for this website because Hugo versions don't always preserve backward compatibility.

To use Docker, install it on your computer using any of the guides on the Internet.

There are two Dockerfiles in this repo: one for editing the site interactively, and one for creating the final build. Create them by running these commands. (This is a one-time action.)

docker build -f Dockerfile-server -t hugo-server .
docker build -f Dockerfile-build  -t hugo-build . 

Interactive editing

Start the Docker server container using these commands:

cd <sqlitebrowser-website-directory>
docker run -it --rm -p 1313:1313 -v $(pwd):/home/hugo/app hugo-server

The container watches all the files in the directory and re-builds as needed. Point your browser to http://localhost:1313 to view changes.

As you edit files, Hugo will rebuild and display the updated pages in the browser.

To exit the Docker container, simply ^C (Ctl-C) to get back to the terminal shell.

Build the site

After all the edits are complete, use the hugo-build container to create the full site in the docs directory. To do this:

cd <sqlitebrowser-website-directory>
docker run --rm -v $(pwd):/home/hugo/app hugo-build

Verify that the resulting files are correct with these commands and browse to http://localhost:1313

cd docs
python -m http.server 1313