From e5ce7c9214f2de3647cbb1c9a1ec67bd82b387f9 Mon Sep 17 00:00:00 2001 From: blueswen Date: Sun, 5 May 2024 22:03:12 +0800 Subject: [PATCH] Add search plugin note --- README.md | 3 +++ demo-mkdocs/docs/index.md | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/README.md b/README.md index 80a7405..e0bb383 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,9 @@ GLightbox is a pure javascript lightbox library with mobile support. 6. Support lightbox image caption, check more details on [Caption](https://blueswen.github.io/mkdocs-glightbox/caption/caption/). 7. Support grouping images as galleries, check more details on [Gallery](https://blueswen.github.io/mkdocs-glightbox/gallery/gallery/). +> [!NOTE] +> If this is your first time using the MkDocs plugin feature, you should know that MkDocs includes a default plugin named `search`. If you want to keep the search feature, you need to add the `search` plugin back to the `plugins` list. + ## How it works 1. Copy GLightbox script file into `site/assets/javascripts/` directory and CSS file into `site/assets/stylesheets/` directory diff --git a/demo-mkdocs/docs/index.md b/demo-mkdocs/docs/index.md index 5b5df50..08ef10b 100644 --- a/demo-mkdocs/docs/index.md +++ b/demo-mkdocs/docs/index.md @@ -77,6 +77,10 @@ GLightbox is a pure javascript lightbox library with mobile support. 6. Support lightbox image caption, check more details on [Caption](./caption/caption.md). 7. Support grouping images as galleries, check more details on [Gallery](./gallery/gallery.md). +!!! note + + If this is your first time using the MkDocs plugin feature, you should know that MkDocs includes a default plugin named `search`. If you want to keep the search feature, you need to add the search plugin back to the `plugins` list. + ## How it works 1. Copy GLightbox script file into `site/assets/javascripts/` directory and CSS file into `site/assets/stylesheets/` directory