Как часто вы проходите следующий процесс при кодировании?
- Нужно [вставить язык программирования здесь] определение функции и примеры
- Google для указанной функции
- Нажмите на первый результат, который будет либо w3schools, если вам не повезло , либо онлайн-руководство по языку, с которым вы имеете дело.
- Поймите, что вам нужна еще одна функция, демо-версия
- Вернитесь в Google вместо использования поиска на веб-сайте языка, потому что это необъяснимо ужасно и медленнее, чем фактическая перезагрузка вкладки после нового поиска в Google
- Промыть и повторить
Как разработчик, который в значительной степени занимается веб-технологиями, я сталкивался с этим довольно часто. Просто найти техническое определение функции или оператора стало гораздо труднее, чем когда-либо, — не с точки зрения сложности, а с точки зрения потерянного времени. Разве не было бы замечательно, если бы у нас были все наши документы по разработке в одном месте, в прекрасном автономном интерфейсе с супербыстрым нечетким поиском, для любого языка? Введите devdocs.io .
Что это?
DevDocs — это веб-приложение, предназначенное для предоставления вам быстрого доступа к справочному руководству практически по всем интерфейсным языкам и библиотекам. В нем перечислены все API данного выбранного языка и их официальная документация в удобном для просмотра и просмотра формате, без ненужных меню и изящных попыток стилизации, которые пытаются реализовать официальные сайты, такие как php.net .
Это Ajax-управляемое веб-приложение с открытым исходным кодом с подсветкой синтаксиса, даже доступное как расширение Chrome или как плагин для Sublime Text или Brackets.
Что оно делает?
Он объединяет справочные руководства на всех популярных языках (при условии, что они имеют свои руководства в легко доступном и удобном для использования формате). Он предоставляет вам удобный и быстрый интерфейс для нечеткого поиска в документации по всем выбранным языкам, чтобы найти нужную информацию в минимально возможном количестве нажатий клавиш. Что нечеткого поиска, вы можете спросить? Нечеткий поиск — это поиск строки, которая приблизительно (не совсем) соответствует введенной вами. Это то, что редакторы, такие как Sublime Text и LightTable, используют для своих окон поиска команд — ввод чего-то вроде «sa» даст вам «Сохранить как …», потому что ввод совпадает с инициалами команды. Ввод «delte» предложит результаты, содержащие «delta» и «delete», а ввод «bgcp» даже даст вам «фоновый клип». Этот тип поиска обеспечивает сверхбыструю точную настройку результатов, и, поскольку они выполняются в режиме реального времени, вы можете смешивать и сопоставлять данные на месте.
содержание
DevDocs загружает индекс справочного руководства для выбранного вами языка, помещая его в локальный кеш, откуда он предоставляет результаты. Это означает, что вам нужно перезагружать языки по вашему выбору на каждой новой машине, но выигрыш в скорости от такого способа работы намного превосходит старомодный Ajax-способ работы с удаленными запросами. Имейте в виду — в настоящее время только индекс находится в автономном режиме, фактический результат, по которому вы щелкаете, подается из удаленного местоположения — например, вам все еще нужен доступ в Интернет для получения документа для массивов JavaScript, даже если он отображается в результатах поиска, даже когда не в сети.
Важно отметить, что загруженное содержимое является официальным. Это означает, что отправленные пользователем записи, такие как комментарии и образцы, игнорируются.
Вы можете осуществлять поиск в DevDocs в определенной языковой области (например, только в PHP), добавляя префикс php к поисковому запросу и нажимая клавишу табуляции или пробел (на мобильном устройстве). Это переключает режим поиска на «только выбранный язык». Чтобы выйти из этого режима, просто возврат из него делает свое дело.
Открытый исходный код и местный
DevDocs является открытым исходным кодом и призывает сообщество внести свой вклад различными способами. Во-первых, он находится на GitHub и предлагает пользователям отправлять вопросы и улучшать код, как любой хороший проект с открытым исходным кодом. Во-вторых, DevDocs можно легко развернуть локально , так что вы можете запустить или разместить свою собственную версию. Адаптировать его, например, к API внутренней системы вашей компании очень просто. И последнее, но не менее важное: DevDocs использует Trello для сбора отзывов пользователей о желаемых языках. Trello, очень эффективный командный список задач, поддерживает различные информационные доски, где люди могут сотрудничать, обсуждать и голосовать за карточки (темы). DevDocs использует эти карты для сбора голосов за интеграцию отдельных языков. Для участия смотрите здесь .
DevDocs поддерживается и обновляется регулярно, и предоставляет различные средства, чтобы быть в курсе изменений:
- сам сайт создаст всплывающее окно с последними изменениями, если вы оставите его открытым до даты обновления
- есть рассылка
- есть аккаунт в твиттере
- есть даже список рассылки
- есть актуальный список изменений
Все они, похоже, взяты из одного и того же источника, поэтому лучше подписаться только на один из них.
Другие льготы
DevDocs полностью оптимизирован для мобильных устройств и очень отзывчив. Он открывается в одно мгновение и работает точно так же, как и на мобильном телефоне. Он построен так, как веб-сайты всегда должны были создаваться — плавный, быстрый и идентичный опыт на каждом устройстве. Тибо Куробл действительно проделал фантастическую работу.
Как уже упоминалось, приложение устанавливается как плагин для Sublime Text и Brackets — это означает, что вы можете искать необходимый API прямо из вашего редактора. В разработке находятся дополнительные плагины, в особенности плагины для продуктов JetBrains. Приложение также переносится в автономную загружаемую автономную версию с нулевой конфигурацией.
DevDocs можно установить как поисковую систему в Firefox и Google Chrome, а также в любом другом браузере и приложении, поддерживающем OpenSearch . OpenSearch — это набор стандартов, позволяющий определенному ресурсу идентифицировать себя как поисковую систему.
Также предлагаются различные сочетания клавиш, все они интуитивно понятны и очень полезны, обеспечивая по-настоящему плавные ощущения.
Вывод
Если вы не слышали о DevDocs до прочтения этой статьи, я настоятельно рекомендую вам попробовать. Сеть остро нуждается в таких очень полезных ресурсах, поэтому распространяйте информацию и помогайте сообществу находить лучшие решения проблем, с которыми они сталкиваются. Если вы можете внести свой вклад, DevDocs участвует в GitTip и поддерживает пожертвования PayPal, но, возможно, лучший способ помочь — это просто использовать его, рассказывать об этом другим и, прежде всего, улучшать его, внося свой вклад в проект на GitHub.