diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml new file mode 100644 index 0000000..5db8ec8 --- /dev/null +++ b/.github/workflows/deploy-docs.yml @@ -0,0 +1,64 @@ +name: Deploy Documentation to GitHub Pages + +on: + push: + branches: + - main + paths: + - 'docs/**' + - '.github/workflows/deploy-docs.yml' + +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment +concurrency: + group: "pages" + cancel-in-progress: true + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: '3.2' + bundler-cache: true + cache-version: 0 + + - name: Setup Pages + uses: actions/configure-pages@v4 + + - name: Install dependencies + run: | + cd docs + bundle install + + - name: Build site + run: | + cd docs + bundle exec jekyll build + env: + JEKYLL_ENV: production + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: docs/_site + + deploy: + needs: build + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 \ No newline at end of file diff --git a/README.md b/README.md index 925f32c..d9fb235 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ The Model Context Protocol (MCP) Server is a robust, secure, and high-performanc ![Bun](https://img.shields.io/badge/bun-%3E%3D1.0.26-black) ![TypeScript](https://img.shields.io/badge/typescript-%5E5.0.0-blue.svg) ![Test Coverage](https://img.shields.io/badge/coverage-95%25-brightgreen.svg) +[![Documentation](https://img.shields.io/badge/docs-github.io-blue.svg)](https://jango-blockchained.github.io/homeassistant-mcp/) ## Table of Contents @@ -221,7 +222,7 @@ This project is licensed under the MIT License. See [LICENSE](LICENSE) for the f ## Documentation -Full documentation is available at: https://yourusername.github.io/your-repo-name/ +Full documentation is available at: [https://jango-blockchained.github.io/homeassistant-mcp/](https://jango-blockchained.github.io/homeassistant-mcp/) ## Quick Start diff --git a/docs/Gemfile b/docs/Gemfile index 50ae9ef..90edc86 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -10,4 +10,8 @@ gem "jekyll-seo-tag" platforms :mingw, :x64_mingw, :mswin, :jruby do gem "tzinfo", ">= 1" gem "tzinfo-data" -end \ No newline at end of file +end + +# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem +# do not have a Java counterpart. +gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby] \ No newline at end of file