https://github.com/wildaid/wildaid.github.io

WildAid Github Pages
https://github.com/wildaid/wildaid.github.io

css documentation hacktoberfest hacktoberfest2020 hacktoberfest2021 html jekyll

Last synced: 2 months ago
JSON representation

WildAid Github Pages

• Host: GitHub
• URL: https://github.com/wildaid/wildaid.github.io
• Owner: WildAid
• License: apache-2.0
• Created: 2020-06-05T20:16:29.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-04-12T06:07:57.000Z (almost 2 years ago)
• Last Synced: 2023-10-20T23:48:10.779Z (about 1 year ago)
• Topics: css, documentation, hacktoberfest, hacktoberfest2020, hacktoberfest2021, html, jekyll
• Language: HTML
• Homepage:
• Size: 125 MB
• Stars: 10
• Watchers: 3
• Forks: 15
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# WildAid O-FISH Documentation

  

The [WildAid Marine Program](https://marine.wildaid.org/) works to protect vulnerable marine environments.

O-FISH (Officer Fishery Information Sharing Hub) is a multi-platform application that enables officers to browse and record boarding report data from their mobile devices.

Developers are expected to follow the MongoDB Community Code of Conduct guidelines.

This repo contains the documentation for end users and developers of all the O-FISH applications and codebases: [iOS](https://github.com/WildAid/o-fish-ios), [Android](https://github.com/WildAid/o-fish-android), [Web](https://github.com/WildAid/o-fish-web) and [Realm](https://github.com/WildAid/o-fish-realm). The documentation itself lives at [https://wildaid.github.io](https://wildaid.github.io).

The details behind the data architecture, schema, and partitioning strategy are described in [Realm Data and Partitioning Strategy Behind the WildAid O-FISH Mobile Apps](https://developer.mongodb.com/how-to/realm-data-architecture-ofish-app).

## Prerequisites

This is a Github Pages site that uses Jekyll. You will need to [install Jekyll](https://jekyllrb.com/docs/installation/).

## Building and testing the documentation

To build the documentation locally, navigate to the publishing source (where this README is) and run:

`bundle exec jekyll serve`



You can see the local site at:


http://localhost:4000



To test that all links work, and all images have alt-tags, and similar issues - run this from the top-level directory (where this README file is):


`./script/test_images_links.sh` 



You must have [htmlproofer](https://github.com/gjtorikian/html-proofer) installed for this to work properly.

## Style guide





The style guide includes notes on accessibility, and can be seen in the [style](https://wildaid.github.io/style) directory.