www/www.studyforrest.org

The website for the studyforrest project

HTML 75.7%
Python 14.6%
CSS 9.4%
JavaScript 0.3%

Find a file

Michael Hanke 373447eb25 All checks were successful Deploy on webserver / Build site with pelican and deploy on success (push) Successful in 45s Details Adjust source pointer.		2025-02-28 15:18:37 +01:00
.forgejo/workflows	Switch to forgejo-based builds, and lab-internal hosting	2025-02-28 15:15:55 +01:00
artwork	drop unused artwork assets	2021-04-26 16:23:24 +02:00
content	Adjust source pointer.	2025-02-28 15:18:37 +01:00
pelican-plugins	add new headerid parameters to README	2024-05-08 14:48:58 +02:00
theme	Adjust source pointer.	2025-02-28 15:18:37 +01:00
tipue-search-lite@c024cdac06	search: replace old tipue-search-lite with new version as submodule	2021-12-03 13:41:04 +01:00
tools	BF: Allow to build non-doi-based URLs for publications that do not have a doi	2021-05-06 14:34:25 +02:00
.gitignore	ignore output/ ; drop tmp/ (tool builds)	2021-04-26 16:02:19 +02:00
.gitmodules	search: replace old tipue-search-lite with new version as submodule	2021-12-03 13:41:04 +01:00
pelicanconf.py	stylize header links	2024-05-13 11:57:36 +02:00
publishconf.py	small language nits	2021-04-28 15:18:40 +02:00
README.md	update the readme	2021-05-01 12:36:22 +02:00
tasks.py	update for pelican 4: drop makefiles and add tasks.py	2021-04-23 15:46:45 +02:00

README.md

StudyForrest Website

This repo has all of the sources and assets to build the website for the StudyForrest project (www.studyforrest.org).

Pages are generated using Pelican.

Content is written predominantly in HTML and reStructuredText. Pelican is flexible like that.

Building

To setup the build environment:

clone the repo and pull submodules

git clone https://github.com/psychoinformatics-de/studyforrest-www.git
cd studyforrest-www
git submodule update --init --recursive

setup and activate a virtualenv

python3 -m venv ~/.venvs/pelican
source ~/.venvs/pelican/bin/activate

install Pelican and dependencies

pip3 install pelican invoke beautifulsoup4

run the development server
```
pelican --autoreload --listen
```
point your browser to http://127.0.0.1:8000.

Your copy of the docs will be served locally at that address, and any changes will automatically trigger a rebuild.

Publishing

GitHub Actions is used to build and test all PRs. When commits make it to the master branch, they are built, the results saved in the gh-pages branch, and then hosted by GitHub Pages.

License

When in doubt, the license of all content/artwork is CC-BY-SA-4.0, SIL OFL 1.1 for fonts, and MIT for all code. Please see the content/pages/copyright.rst page for a more granular, Debian-style declaration of files and their licenses.