Skip to content

Commit

Permalink
Add search plugin note
Browse files Browse the repository at this point in the history
  • Loading branch information
blueswen committed May 5, 2024
1 parent d7747e7 commit e5ce7c9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions demo-mkdocs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e5ce7c9

Please sign in to comment.