From 7fa82cccf3451b9fb7c38784580ad611d90121b1 Mon Sep 17 00:00:00 2001 From: Eric Knibbe Date: Mon, 13 May 2024 14:09:44 -0400 Subject: [PATCH 1/2] docs: rename README.md to index.md --- docs/{README.md => index.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{README.md => index.md} (100%) diff --git a/docs/README.md b/docs/index.md similarity index 100% rename from docs/README.md rename to docs/index.md From e1f8b622ff8f40db1c9c44d02dd6794fae283a93 Mon Sep 17 00:00:00 2001 From: Eric Knibbe Date: Mon, 13 May 2024 14:13:07 -0400 Subject: [PATCH 2/2] docs: add webrick gem, generation info --- docs/Gemfile | 1 + docs/README.md | 17 +++++++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 docs/README.md diff --git a/docs/Gemfile b/docs/Gemfile index 50368eba34..b23583ab53 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -6,4 +6,5 @@ group :test do gem "html-proofer" gem "mdl" gem "rake" + gem "webrick" end diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000..0e915d7c48 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,17 @@ +# Homebrew Docs + +These are the source files for the [Homebrew documentation site](https://docs.brew.sh/). + +A [GitHub Action](https://github.com/Homebrew/brew/blob/master/.github/workflows/docs.yml) is run to validate each change before the site is deployed to GitHub Pages. + +## Usage + +Open in your web browser. + +To instead generate the site locally to , run: + +```bash +cd `brew --repository`/docs +bundle install +bundle exec jekyll serve --watch +```