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 +```