Lightweight and simple static site template for researchers in the Digital Humanities.
Built and supported by Codex Felis
Paws is a static site built on SvelteKit, using Markdown for blog content, optionally with Netlify CMS. Developer tooling to help with editing the template in VSCode is provided.
"Static site" means that the website is made up of pre-built HTML, CSS and a tiny bit of JavaScript. The web pages load the same way every time, unlike dynamic websites, which load differently based on things such as the user's location, the time of day, or user actions. A static website can be served for free or very low cost, and provides a smooth and fast experience for users of the website. There's no content database to make things slow, or pose security issues as in for example a Wordpress site.
Use this template in GitHub, or read the deployed documentation. This is also a demo site, with source available in the paws-demo repository.
Get up and running with this site really fast! For an opinionated quickstart, you need to have
- clicked "use this template" in GitHub, so you have your own copy of this repository, and cloned it to your own computer
- set up a free account on Netlify ready for deployment (other static site hosting options are fine if you know how)
- thought about whether you are happy writing blog content in files in GitHub, or prefer to use a CMS for web-based writing.
- thought about whether this template has the right site sections (home/blog/about) for you, or if you need extra pages
Head to the deployed documentation for the rest of the setup instructions.
While this template is still under development, these docs assume that you:
- are vaguely familiar with basic git commands (clone, add, commit, push) and GitHub
- know how to edit HTML/JavaScript files on your computer (even if you don't fully understand what they mean)
- are able to set up a working NodeJS environment on your computer.
More comprehensive beginner documentation is coming soon, and if you get stuck feel free to contact us for help or raise an issue in GitHub.
Paws needs a local NodeJS (>=14.13) environment. Get started with
# install the required dependencies
npm install
# run the developemnt server to preview changes in your browser
npm run dev