brown-ccv / ccv-website-content

YAML and Markdown files corresponding to the content of ccv.brown.edu
1 stars 8 forks source link

CCV Website Content

Validation

We use [Yamale]() together with GitHub Actions to make sure that the content of files adheres to a specific schema.

All schemas are defined in the schemas folder. When you open a Pull Request, the necessary validations are run. However, if you would like to validate the yml file locally you can install Yamale

To install Yamale, you can use pipx (or pip)

pipx install yamale

Then specify the schema and content folder (or file) to verify. For instance,

yamale -s schemas/software.yml our-work/software

Icons

When icons are necessary, please refer to these icons. Note that the version linked here may have changed from that one included in the website.