10 Commits

Author SHA1 Message Date
Mike McQuaid
681e803c4f
docs: improve/fix jekyll setup 2025-04-25 09:46:29 +01:00
Mike McQuaid
1b8bddd8bf
docs: brew style --fix 2024-06-13 09:55:31 +01:00
Mike McQuaid
3392226a10
Include more Ruby metadata files
- include `.ruby-version` and in the project root (and unignore in
  `.gitignore`) to improve editor support which expects these files
- use the `.ruby-version` in `docs/Gemfile` to use a consistent Ruby
  version here
- remove hardcoded Ruby versions from `workflows/docs` in favour of
  using the `.ruby-version` file instead
- use more consistent configuration in `workflows/docs` to match
  `workflows/tests`
2024-05-23 16:29:14 +01:00
Eric Knibbe
e1f8b622ff
docs: add webrick gem, generation info 2024-05-13 14:13:07 -04:00
EricFromCanada
45bf8b0118
docs: add mdl for Markdown linting
Run with `mdl -c docs/.mdlrc docs/*.md`.
2021-12-02 22:58:31 -05:00
Mike McQuaid
8a2490a1d3
docs: check links with html-proofer
This can be done with `bundle exec rake test`.
2018-10-04 15:37:01 +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
2f522ff04b docs: update gems.
- check in the Gemfile.lock
- use a modern Ruby version
- remove gem upper limits
2018-01-15 09:55:28 +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