Repo for development of the interactive OCEANIS tool.
The site uses GitHub Pages' built-in Jekyll support. Shared navigation and footer markup live in _includes/, the page wrapper is in _layouts/default.html, and page content stays in small root-level HTML files. The main pages are index.html (overview), interactive.html (spiderweb), and resources.html (resource library).
Install Ruby and Jekyll, then run jekyll serve --baseurl "" from the repository root for a local preview. Open the local URL printed by Jekyll; the site rebuilds when files change. The workflow in .github/workflows/deploy.yml builds and deploys the site on pushes to main and can also be run manually.
To add to the list of contributors, go to the contribs folder and open the contributors.csv file. To edit the file, you have two options:
- Click the pencil in the top right. Then edit the file directly. Do not add spaces between commas separating names, but within a name or organization title it's okay. Example: FIRST NAME,LAST NAME,ORGANIZATION TITLE,EMAIL. Email is optional and we can remove this column if necessary. When you're done, click the green commit changes button.
- Download the csv file by clicking the three ... button in the top right, make edits in your prefered csv-editing software (e.g. Excel).
a. Reupload the file by navigating the the contribs folder.
b. Click add file, then upload the modified file. Do not change the file name, it's okay if it is overwritten. If you need to add, remove, or change columns, please make sure there is always "First Name", "last Name", and "Organization". Contact @EliLawrence for questions.
- Navigate to the directory containing project files. For example: cd /path/to/your/project
- Start the HTTP server:
python -m http.server 8000 - Navigate to http://localhost:8000