23 Commits

Author SHA1 Message Date
Leo Heitmann Ruiz
4f787bc233 Use SVG logo in header 2024-03-31 21:46:25 +02:00
Mike McQuaid
fbf71e7b96
docs/config: remove feed.
This slightly speeds up generation and it's no longer needed as of
https://github.com/Homebrew/brew.sh/pull/955 and
https://github.com/Homebrew/brew.sh/pull/956.
2023-06-06 12:02:22 -04:00
Dawid Dziurla
c775513127
docs: mention Linux on site description 2023-01-28 22:09:17 +01:00
EricFromCanada
42e91e8668
docs: add Table of Contents to selected pages 2022-12-30 00:45:30 -05:00
EricFromCanada
5e23ad46cd
docs: add automatic listing of governance archives 2022-05-01 21:37:20 -04:00
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
Mike McQuaid
710859e300
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
Mike McQuaid
e0db3a214a
docs/_config.yml: shorten search placeholder.
Current one is truncated on macOS.
2019-03-07 19:07:13 +00:00
Mike McQuaid
2ac9242562
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
Mike McQuaid
8ab71de3e9 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
Mike McQuaid
877f059552 docs/_config.yml: remove GitHub repository.
This seems like it could fix the GitHub Pages build.
2018-05-03 08:31:32 +01:00
Mike McQuaid
70f817f02e docs: try Homebrew/jekyll-theme-homebrew. 2018-05-02 21:07:54 +01:00
Mike McQuaid
bb807d813a 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
Mike McQuaid
21dba9228c 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
Mike McQuaid
650d6dbaac _config.yml: use extensionless permalinks. 2018-02-23 19:52:11 +00:00
Mike McQuaid
5b35ba6191 docs/config.yml: generate README.md again.
This is the index.
2018-02-22 18:57:24 +00:00
Mike McQuaid
977c3323d2 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
Mike McQuaid
31ca5c9aed docs/config: add missing feed plugin. 2017-07-02 15:13:00 +01:00
Mike McQuaid
72c24b9498 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:26 +01:00
Mike McQuaid
c7c0ad6e61 Add acme challenge. 2017-05-04 12:18:56 +01:00
Mike McQuaid
eaf8cc1be0 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
Mike McQuaid
127e9def50 Cleanup documentation site
GitHub now nicely generates a documentation site for us at
http://brew.sh/brew based on our docs folder. Optimise the output of
this and the GitHub docs directory for readability and the various user
groupings.
2017-01-04 10:53:21 +00:00
Mike McQuaid
824768e26f Set theme jekyll-theme-cayman 2017-01-03 15:59:15 +00:00