admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/docs/_config.yml

37 lines
620 B
YAML
Raw Normal View History

docs.brew.sh updates - Remove no longer needed `acme-challenge` file - Set title, description, social image, logo, etc. for SEO - Use extensionless permalinks (old links still work) - Cleanup `_config.yml` - Import latest `_layouts/base` from https://brew.sh
2018-02-22 18:47:29 +00:00
title: Homebrew Documentation
description: Documentation for the missing package manager for macOS.
docs.brew.sh: use brew.sh theming. Unfortunately there's no easy way to share this code with the brew.sh site but it's at least able to have the `css/`, `img/` (root) and `_layouts` directories in sync between the two repositories. Some small CSS tweaks were needed to make these pages render more attractively.
2017-03-05 15:25:51 +00:00
docs/_config.yml: use brew.sh theme name. This has been updated now we have a newer version of jekyll-remote-theme.
2018-05-14 18:43:15 +01:00
remote_theme: Homebrew/brew.sh
Use Homebrew’s Jekyll theme These means we can remove a bunch of the HTML from this repository and move it to https://github.com/homebrew/jekyll-theme-homebrew.
2018-05-02 17:57:32 +01:00
docs.brew.sh updates - Remove no longer needed `acme-challenge` file - Set title, description, social image, logo, etc. for SEO - Use extensionless permalinks (old links still work) - Cleanup `_config.yml` - Import latest `_layouts/base` from https://brew.sh
2018-02-22 18:47:29 +00:00
exclude:
- bin
- CNAME
- Gemfile*
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-09 18:42:14 +00:00
- vale-styles
docs.brew.sh updates - Remove no longer needed `acme-challenge` file - Set title, description, social image, logo, etc. for SEO - Use extensionless permalinks (old links still work) - Cleanup `_config.yml` - Import latest `_layouts/base` from https://brew.sh
2018-02-22 18:47:29 +00:00
- vendor
docs: Add sitemap.xml, robots.txt. Also, while we're here, cleanup the favicon and apple-touch-icon duplication mess.
2017-07-02 15:09:10 +01:00
docs.brew.sh updates - Remove no longer needed `acme-challenge` file - Set title, description, social image, logo, etc. for SEO - Use extensionless permalinks (old links still work) - Cleanup `_config.yml` - Import latest `_layouts/base` from https://brew.sh
2018-02-22 18:47:29 +00:00
plugins:
docs/config: add missing feed plugin.
2017-07-02 15:13:00 +01:00
- jekyll-feed
Update Linuxbrew references to Homebrew on Linux This is a clearer branding for us to use. Also, as part of testing this, make some fixes to Jekyll in the docs folder. Fixes #5835
2019-03-12 20:13:38 +00:00
- jekyll-redirect-from
docs: fix Jekyll theme usage. Need to use `remote_theme` not `theme` for this to work on GitHub Pages. Handily, though, this removes the need for making and uploading a gem.
2018-05-02 20:00:22 +01:00
- jekyll-remote-theme
- jekyll-seo-tag
docs: Add sitemap.xml, robots.txt. Also, while we're here, cleanup the favicon and apple-touch-icon duplication mess.
2017-07-02 15:09:10 +01:00
- jekyll-sitemap
docs.brew.sh updates - Remove no longer needed `acme-challenge` file - Set title, description, social image, logo, etc. for SEO - Use extensionless permalinks (old links still work) - Cleanup `_config.yml` - Import latest `_layouts/base` from https://brew.sh
2018-02-22 18:47:29 +00:00
_config.yml: use extensionless permalinks.
2018-02-23 19:51:29 +00:00
permalink: :title
docs.brew.sh updates - Remove no longer needed `acme-challenge` file - Set title, description, social image, logo, etc. for SEO - Use extensionless permalinks (old links still work) - Cleanup `_config.yml` - Import latest `_layouts/base` from https://brew.sh
2018-02-22 18:47:29 +00:00
defaults:
- scope:
path: ""
values:
docs: fix Jekyll theme usage. Need to use `remote_theme` not `theme` for this to work on GitHub Pages. Handily, though, this removes the need for making and uploading a gem.
2018-05-02 20:00:22 +01:00
image: /assets/img/homebrew-256x256.png
docs/_config.yml: shorten search placeholder. Current one is truncated on macOS.
2019-03-07 19:07:13 +00:00
search_name: Documentation
docs/_config.yml: enable documentation search. Set the search placeholder badge, the index and trigger a new GitHub Pages build (by merging this).
2019-03-07 18:38:44 +00:00
search_site: docs
docs.brew.sh updates - Remove no longer needed `acme-challenge` file - Set title, description, social image, logo, etc. for SEO - Use extensionless permalinks (old links still work) - Cleanup `_config.yml` - Import latest `_layouts/base` from https://brew.sh
2018-02-22 18:47:29 +00:00
docs: fix Jekyll theme usage. Need to use `remote_theme` not `theme` for this to work on GitHub Pages. Handily, though, this removes the need for making and uploading a gem.
2018-05-02 20:00:22 +01:00
logo: /assets/img/homebrew-256x256.png
docs.brew.sh updates - Remove no longer needed `acme-challenge` file - Set title, description, social image, logo, etc. for SEO - Use extensionless permalinks (old links still work) - Cleanup `_config.yml` - Import latest `_layouts/base` from https://brew.sh
2018-02-22 18:47:29 +00:00
twitter:
username: MacHomebrew
facebook:
publisher: https://www.facebook.com/machomebrew/
Reference in New Issue Copy Permalink