Create FAQ search functionality in static pages
Open
Nobody has claimed this yet.
dev: enhancement 🛠️✨
- Dominant language
- Python
- Stars
- 24
- Forks
- 15
- Avg merge
- 10d 3h
- Merged PRs (30d)
- 1
Description
Mkdocs Material has an "icon search" feature in their own docs. I would like to repurpose their work to create an FAQ search function.
- JS
- https://github.com/squidfunk/mkdocs-material/blob/c68fac7fb3071fa4f45cc823e2ca2ea82fd67b43/src/overrides/assets/javascripts/templates/iconsearch/index.tsx#L78
- https://github.com/squidfunk/mkdocs-material/blob/c68fac7fb3071fa4f45cc823e2ca2ea82fd67b43/src/overrides/assets/javascripts/components/iconsearch/result/index.ts#L189
- SCSS
- HTML
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the linked MkDocs Material icon-search TypeScript, SCSS, and HTML examples, then locate how this repository builds its static documentation pages. Adapt the referenced search UI for the FAQ content and verify that users can search and open matching FAQ entries on the generated pages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html, javascript, scss
- Domain
- documentation, search, web-dev
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100