Быстрый поиск по всем документациям

от автора

Недавно я задался вопросом, могу ли я оптимизировать процесс поиска чего-либо в документации любого языка/библиотеки/фреймворка. Прыгать с сайта на сайт – не самая лучшая идея, ибо интерфейсы документацией отличаются, а я хотел унификации.

Сначала мне пришла мысль взглянуть на уже существующие решения, среди которых есть мною любимый Zeal, однако, он доступен только для Windows и Linux, я же крепко сижу в заложниках на MacOS из-за специфики работы и удобства.

На сайте Zeal предлагают перейти на сайт Dash, который по сути является прародителем Zeal, однако, он платный и за него невозможно заплатить в пределах РФ, поэтому я продолжил дальше искать аналоги.

Среди альтернатив также есть DevDocs, который может работать оффлайн в браузере (благодаря PWA), однако, я заметил, что все время держать открытой лишнюю вкладку для поиска в доках было не лучшей идеей (ибо вкладку все равно нужно было бы искать, среди тонны вкладок со StackOverflow и прочим).

Решение с быстрым поиском

В Firefox и Google Chrome есть возможность добавить собственную поисковую систему (или же поиск по сайту), чем собственно я и воспользовался. При поиске в devdocs все GET-запросы уходят по урлу:

https://devdocs.io/#q={запрос}

Если мы добавим данную ссылку в раздел «Поисковая система >> Поиск по сайту», то сможем добиться быстрого поиска по данному сайту:

После того как я добавил новый «поиск по сайту» я могу ввести в поисковой строке «dd» и быстро перейти к поиску чего-либо на всех включенных документациях на devdocs.io:

Таким образом я смог добиться быстрого поиска по всем документациям, которые отображаются в едином стиле благодаря devdocs.

Подводя итоги

Итак, для того чтобы мы могли быстро искать что-либо по всем нужным нам документациям, нам достаточно:

  1. Перейти на devdocs.io

  2. Установить нужные нам пакеты документации

  3. Скачать их для поддержки работы в оффлайн (делается в настройках)

  4. Зайти в настройки браузера (вкладка – «Поисковая система»)

  5. Добавить новый «Поиск по сайту» и написать в поле URL «https://devdocs.io/#q=%s»

  6. Profit 🙂

Если вам понравилась данная статья — то вы всегда можете перейти в мой блог, там больше схожей информации о веб-разработке.

Если у вас остались вопросы — не стесняйтесь задавать их в комментариях. Хорошего времяпрепровождения! ??‍♂


ссылка на оригинал статьи https://habr.com/ru/articles/830298/


Комментарии

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *