This repository contains the website of the Digital Humanities at the University of Bern. The data in this repository is openly available to everyone and is intended to support reproducible research.
The structure of this repository follows the Advanced Structure for Data Analysis of The Turing Way and is organized as follows:
.github/- Contains the GitHub configuration files, including the issue templates and workflows..husky/- Contains the Husky configuration files, including the pre-commit hooks and the Husky settings..venv/- Contains the Python virtual environment used to build the website, including the Python packages and their versions.assets/- Contains all the assets used in the website, including images, stylesheets, and JavaScript files.content/- Contains the content of the website, including the main page and any additional pages.renv/- Contains the R environment used to build the website, including the R packages and their versions.
We recommend using GitHub Codespaces for the easiest and fastest setup. It gives you a pre-configured, cloud-based development environment with everything ready to go — directly in your browser.
- Fork this repository to your GitHub account (if needed).
-
Click the green
<> Codebutton at the top right of this repository. -
Select the “Codespaces” tab and click “Create codespace on
main”.
-
GitHub will now build a container that includes:
- ✅ Node.js (via
npm) - ✅ Python with
uv - ✅ R with
renv - ✅ Quarto
- ✅ Node.js (via
-
Once the Codespace is ready, you can preview the documentation locally inside the Codespace with:
- Open a terminal in the Codespace (Terminal > New Terminal).
- Run the following command to install all dependencies:
uv run quarto preview
👩💻 Setup locally (Advanced users)
Make sure the following tools are installed locally:
- Node.js
- R and Rtools (on Windows)
- uv (Python manager)
- Quarto
Note:
uvautomatically manages a Python version if none is installed.
# 1. Install Node.js dependencies
npm install
# 2. Setup Python environment
uv sync
# 3. Setup R environment
Rscript -e 'install.packages("renv"); renv::restore()'
# 4. Preview documentation
uv run quarto previewCheck that all files are properly formatted.
npm run checkFormat all files.
npm run formatRun the wizard to write meaningful commit messages.
npm run commitRun the wizard to create a CHANGELOG.md.
npm run changelogPreview the documentation.
uv run quarto previewThis project is maintained by @DHBern. Please understand that we can't provide individual support via email. We also believe that help is much more valuable when it's shared publicly, so more people can benefit from it.
| Type | Platforms |
|---|---|
| 🚨 Bug Reports | GitHub Issue Tracker |
| 📊 Report bad data | GitHub Issue Tracker |
| 📚 Docs Issue | GitHub Issue Tracker |
| 🎁 Feature Requests | GitHub Issue Tracker |
| 🛡 Report a security vulnerability | See SECURITY.md |
| 💬 General Questions | GitHub Discussions |
TBA
All contributions to this repository are welcome! If you find errors or problems with the data, or if you want to add new data or features, please open an issue or pull request. Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.
We use SemVer for versioning. The available versions are listed in the tags on this repository.
- Moritz Mähr - Initial work - maehr
See also the list of contributors who contributed to this project.
The data in this repository is released under the Creative Commons Attribution 4.0 International (CC BY 4.0) License - see the LICENSE-CCBY file for details. By using this data, you agree to give appropriate credit to the original author(s) and to indicate if any modifications have been made.
The code in this repository is released under the GNU Affero General Public License v3.0 - see the LICENSE-AGPL file for details. By using this code, you agree to make any modifications available under the same license.