{"id":26005400,"url":"https://github.com/precice/precice.github.io","last_synced_at":"2026-04-01T21:06:41.489Z","repository":{"id":38417272,"uuid":"293541698","full_name":"precice/precice.github.io","owner":"precice","description":"The website of preCICE","archived":false,"fork":false,"pushed_at":"2024-04-13T09:51:33.000Z","size":388654,"stargazers_count":12,"open_issues_count":48,"forks_count":54,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-04-13T20:55:33.152Z","etag":null,"topics":["precice"],"latest_commit_sha":null,"homepage":"https://precice.org/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/precice.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"licenses/LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null},"funding":{"custom":"https://precice.org/community-support-precice"}},"created_at":"2020-09-07T13:52:27.000Z","updated_at":"2024-04-15T05:26:06.760Z","dependencies_parsed_at":"2023-10-15T16:48:05.062Z","dependency_job_id":"55231411-b38d-45ad-84a6-7d50923f72d8","html_url":"https://github.com/precice/precice.github.io","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/precice%2Fprecice.github.io","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/precice%2Fprecice.github.io/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/precice%2Fprecice.github.io/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/precice%2Fprecice.github.io/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/precice","download_url":"https://codeload.github.com/precice/precice.github.io/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242103943,"owners_count":20072368,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["precice"],"created_at":"2025-03-05T20:53:53.093Z","updated_at":"2026-04-01T21:06:41.447Z","avatar_url":"https://github.com/precice.png","language":"HTML","funding_links":["https://precice.org/community-support-precice"],"categories":[],"sub_categories":[],"readme":"# preCICE Webpage - [precice.org](https://precice.org/)\n\n## Local development\n\nFirst install [`pre-commit`](https://repology.org/project/python:pre-commit/versions) to keep your commits clean.\n\nThe website is using [Jekyll](https://jekyllrb.com/) static website generator and [Github pages](https://pages.github.com/).\nTo run and develop it locally you need to install [`rbenv`](rbenv.org) using `apt install rbenv ruby-build`.\nThen use `rbenv init` and follow the instructions to set it up.\nWith `rbenv` installed and activated in your shell:\n\n```bash\ngit clone --recurse-submodules https://github.com/precice/precice.github.io \u0026\u0026 cd precice.github.io\npre-commit install\nrbenv install\nbundle install\nbundle exec jekyll serve -l\n```\n\nYou can now view website locally in your browser at `localhost:4000`.\n\n## Update submodules\n\nSubmodules do not yet get updated automatically. This means if you change something in the OpenFOAM adapter documentation or the description of the tutorials, you need to explicitly trigger an update here:\n\n```bash\ngit submodule update --remote --merge\n```\n\nThis updates **all** submodules. You can call it from everywhere (you do not need to `cd` into the submodule).\nAfterwards, commit and push.\n\nDo not directly edit the content of the submodules from within the website repository. This might give ugly merge conflicts.\n\n## Pull with submodules\n\nTo pull changes including submodules\n\n```bash\ngit pull --recurse-submodules\n```\n\n## Build inside a Docker container\n\nInstead of building on your system (which requires some setup the first time), you can directly serve the website from a Docker container (using the community image [`jekyll/jekyll`](https://hub.docker.com/r/jekyll/jekyll)). In this directory, after you initialize and update the git submodules, run the following:\n\n```shell\ndocker run --rm --volume=\"$PWD:/srv/jekyll:Z\" --publish 127.0.0.1:4000:4000 -it jekyll/jekyll jekyll serve\n```\n\nArguments:\n\n* `docker run`: The Docker command to run a container from an existing image\n* `--rm`: Automatically remove (or not) the container when it exists\n* `--volume`: Mount the current directory (`$PWD`) to a directory in the container (`/srv/jekyll`), so that only the current container can see the content (`:Z`)\n* `--publish`: Publish the container's port 4000 (where Jekyll serves the website) to the host port 4000. Note that `127.0.0.1` is the localhost in IPv4. For IPv6, you can replace that with `[::1]`.\n* `-it`: Interactive container, capturing signals (such as `Ctrl-C`).\n* `jekyll/jekyll`: The image\n* `jekyll serve`: The command to run. Somehow, the current default `make` target does not work in this context.\n\n## Further information\n\nIf you would like to learn more about the preCICE documentation, a good start are the [documentation of the documentation pages](https://precice.org/docs-meta-overview.html).\n\n## Changing the news banner\n\nEdit [`_includes/news_banner.html`](_includes/news_banner.html).\n\nA good starting point is the following:\n\n```html\n\u003cdiv class=\"background-light banner-container\"\u003e\n  \u003cdiv class=\"container\"\u003e\n    \u003cdiv class=\"row no-margin\"\u003e\n      \u003cdiv class=\"col-lg-12 banner\"\u003e\n        \u003cp class=\"no-margin\"\u003e\n          This is the text of my news banner.\n        \u003c/p\u003e\n      \u003c/div\u003e\n    \u003c/div\u003e\n  \u003c/div\u003e\n\u003c/div\u003e\n```\n\nUse the following to selectively change appearance.\n\n```html\n{% if include.landing %}\n  Displayed on the landing page.\n{% else %}\n  Displayed on other pages.\n{% endif %}\n```\n\n## Common issues while building the site\n\n* If you get permission issues to install gems, resist the impulse of `sudo`: you can install the dependencies locally by running `bundle config set --local path 'vendor/bundle'` before `bundle install`.\n\n* If you get errors like `Gem::Ext::BuildError: ERROR: Failed to build gem native extension.` or `mkmf.rb can't find header files for ruby at /usr/lib/ruby/include/ruby.h`, then (as the error message suggests), you may need to install a Ruby development environment (e.g., `ruby-dev`).\n\n* If you are a poor soul that is stuck developing on Windows, the `-l` flag is known to crash, so best try without.\n\n* Should you get the warning\n\n    ```bash\n    Fetching citation data failed with OpenURI::HTTPError\n    ```\n\n    while building the site locally, then you have been rate limited by Google Scholar. The citation database won't be up to date. Alternatively open [http://scholar.google.com/](http://scholar.google.com/) in a browser and complete the Captcha.\n\nFor further information see the [documentation page on common issues](https://precice.org/docs-meta-common-issues.html).\n\n## Licenses\n\nThe content of the preCICE webpage is licensed under [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/deed.en). Third-party licenses (e.g. of the framework we use) are collected in the `licenses` subfolder. Note that preCICE itself has a software license, [LGPL v3](https://www.gnu.org/licenses/lgpl-3.0.en.html).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprecice%2Fprecice.github.io","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprecice%2Fprecice.github.io","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprecice%2Fprecice.github.io/lists"}