From dba49d8e559d4b90c8e9f19dc5f6ac5ab6f4fa7d Mon Sep 17 00:00:00 2001 From: Dominik Schrempf Date: Fri, 18 Apr 2025 06:33:06 +0200 Subject: [PATCH 1/3] docs: various fixes with mkdocs ci build I noticed the documentation has not been updated in the last five years. This commit fixes the documentation CI build. The rendered page can be viewed here: https://dschrempf.github.io/lsp-haskell/ - Emoji extension was moved into `mkdocs-material` - Do not use Docker container which is supposedly intended for local previews (https://squidfunk.github.io/mkdocs-material/getting-started/#with-docker) - Install the necessary plugins using `pip` This commit also updates the used GitHub Actions. --- .github/workflows/docs.yml | 19 +++++++++---------- .github/workflows/test.yml | 2 +- mkdocs.yml | 4 ++-- 3 files changed, 12 insertions(+), 13 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 74d3865..3d4b9e7 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -8,15 +8,14 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 - - - name: MkDocs - run: | - cp -rf README.md images docs - docker run --rm -v ${PWD}:/docs squidfunk/mkdocs-material -- build + uses: actions/checkout@v4 + with: + fetch-depth: 0 - - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + - uses: actions/setup-python@v5 with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./site + python-version: 3.x + + - run: pip install mkdocs-material mkdocs-awesome-pages-plugin mkdocs-git-revision-date-localized-plugin + - run: cp -r README.md images docs + - run: mkdocs gh-deploy --force diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 580db60..0c7c58c 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -33,7 +33,7 @@ jobs: experimental: true steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: jcs090218/setup-emacs@master with: diff --git a/mkdocs.yml b/mkdocs.yml index f067b6c..edf1752 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -25,8 +25,8 @@ repo_url: https://github.com/emacs-lsp/lsp-haskell markdown_extensions: - pymdownx.superfences - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji - emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg - codehilite - toc: permalink: '#' From 1704ff2854686c7c5928b031df152cef35167652 Mon Sep 17 00:00:00 2001 From: Dominik Schrempf Date: Fri, 18 Apr 2025 08:38:40 +0200 Subject: [PATCH 2/3] docs: fix ci badge in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2466460..c8a467f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ lsp-haskell =========== -[![MELPA](https://melpa.org/packages/lsp-haskell-badge.svg)](https://melpa.org/#/lsp-haskell) [![Build Status](https://travis-ci.com/emacs-lsp/lsp-haskell.svg?branch=master)](https://travis-ci.com/emacs-lsp/lsp-haskell) +[![MELPA](https://melpa.org/packages/lsp-haskell-badge.svg)](https://melpa.org/#/lsp-haskell) ![Build Status](https://github.com/emacs-lsp/lsp-haskell/actions/workflows/test.yml/badge.svg) An Emacs Lisp library for interacting with a Haskell language server such as [`haskell-language-server`](https://github.com/haskell/haskell-language-server/) using Microsoft's [Language Server Protocol](https://github.com/Microsoft/language-server-protocol/). From c589fa7efc1b2c0a5d36995ffce67191c36f4ce7 Mon Sep 17 00:00:00 2001 From: Dominik Schrempf Date: Fri, 18 Apr 2025 08:40:55 +0200 Subject: [PATCH 3/3] docs: add docs badge to readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c8a467f..47ce987 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ lsp-haskell =========== -[![MELPA](https://melpa.org/packages/lsp-haskell-badge.svg)](https://melpa.org/#/lsp-haskell) ![Build Status](https://github.com/emacs-lsp/lsp-haskell/actions/workflows/test.yml/badge.svg) +[![MELPA](https://melpa.org/packages/lsp-haskell-badge.svg)](https://melpa.org/#/lsp-haskell) ![Build Status](https://github.com/emacs-lsp/lsp-haskell/actions/workflows/test.yml/badge.svg) ![Docs](https://github.com/emacs-lsp/lsp-haskell/actions/workflows/docs.yml/badge.svg) An Emacs Lisp library for interacting with a Haskell language server such as [`haskell-language-server`](https://github.com/haskell/haskell-language-server/) using Microsoft's [Language Server Protocol](https://github.com/Microsoft/language-server-protocol/).