brew/docs/_config.yml
Issy Long 2a53448685
Add Vale linting for our docs
- I noticed that another open source project had taken the Homebrew
  style guide and made it into [Vale linting
  rules](https://github.com/testthedocs/vale-styles/tree/master/Homebrew).
  This copies them into here, so that we can make use of them. Thanks!
- What use is a style guide if our own docs don't at least try to
  adhere to it? This aims to make the rules more visible to all
  contributors.
- In order for these to do anything, you'll have to `brew install vale`
  and run `vale` in the root of this repo. It will look for Markdown
  files.
- A next step would be adding this as a pre-commit hook, or...
- The GitHub Action would have been really good, but [it doesn't support
  forks](https://github.com/errata-ai/vale-action#limitations).
2019-12-17 21:42:53 +00:00

37 lines
620 B
YAML

title: Homebrew Documentation
description: Documentation for the missing package manager for macOS.
remote_theme: Homebrew/brew.sh
exclude:
- bin
- CNAME
- Gemfile*
- vale-styles
- vendor
plugins:
- jekyll-feed
- jekyll-redirect-from
- jekyll-remote-theme
- jekyll-seo-tag
- jekyll-sitemap
permalink: :title
defaults:
- scope:
path: ""
values:
image: /assets/img/homebrew-256x256.png
search_name: Documentation
search_site: docs
logo: /assets/img/homebrew-256x256.png
twitter:
username: MacHomebrew
facebook:
publisher: https://www.facebook.com/machomebrew/