Skip to content

Latest commit

 

History

History
183 lines (133 loc) · 6.66 KB

plugins.md

File metadata and controls

183 lines (133 loc) · 6.66 KB
Raw

Плагины

Полно-текстовый поиск

По умолчанию гиперссылка на текущую страницу распознается и содержимое сохраняется в localStorage. Вы также можете указать путь к файлам.

<script>
  window.$docsify = {
    search: 'auto', // по умолчанию

    search : [
      '/',            // => /README.md
      '/guide',       // => /guide.md
      '/get-started', // => /get-started.md
      '/ru-ru/',      // => /ru-ru/README.md
      '/zh-cn/',      // => /zh-cn/README.md
    ],

    // полные параметры конфигурации
    search: {
      maxAge: 86400000, // Срок действия, по умолчанию один день
      paths: [], // или 'auto'
      placeholder: 'Введите что начать поиск',

      // Локализация
      placeholder: {
        '/ru-ru/': 'Поиск',
        '/zh-cn/': '搜索',
        '/': 'Type to search'
      },

      noData: 'No Results!',

      // Локализация
      noData: {
        '/ru-ru/': 'Нет результатов',
        '/zh-cn/': '找不到结果',
        '/': 'No Results'
      },

      // Глубина по заголовкам, 1 - 6
      depth: 2
    }
  }
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>

Google Analytics

Установите плагин и настройте track id.

<script>
  window.$docsify = {
    ga: 'UA-XXXXX-Y'
  }
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
<script src="//unpkg.com/docsify/lib/plugins/ga.min.js"></script>

Настройте data-ga.

<script src="//unpkg.com/docsify/lib/docsify.min.js" data-ga="UA-XXXXX-Y"></script>
<script src="//unpkg.com/docsify/lib/plugins/ga.min.js"></script>

emoji

По умолчанию используется поддержка парсинга emoji. Например, :100: будет заменён на 💯. Но он не является точным, потому что нет соответствующей non-emoji стоки. Если вам нужно правильно разобрать строку emoji, вам нужно установить этот плагин.

<script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>

Внешний скрипт

Если скрипт на странице является внешним (импортирует файл js через атрибут src), вам понадобится этот плагин, чтобы он работал.

<script src="//unpkg.com/docsify/lib/plugins/external-script.min.js"></script>

Увеличить изображение

Среднее увеличение изображение. Основано на medium-zoom.

<script src="//unpkg.com/docsify/lib/plugins/zoom-image.min.js"></script>

Исключить специальное изображение

![](image.png ':no-zoom')

Редактировать на github

Добавляет кнопку Редактировать на github на каждой странице. Предоставлено @njleonzhang, проверить документ

Демо code с мгновенным просмотром и интеграцией jsfiddle

С помощью этого плагина код образца можно мгновенно отобразить на странице, чтобы читатели могли сразу его просмотреть. Когда читатели расширяют демонстрационный бокс, там отображаются исходный код и описание. если они нажмут кнопку Попробовать в Jsfiddle, jsfiddle.net будет открыт с кодом этого образца, который позволит читателям пересмотреть код и попробовать самостоятельно.

Vue и React поддерживаются.

Копировать в буфер обмена

Добавить простую кнопку Click to copy для всех отформатированных блоков кода, чтобы легко позволить пользователям копировать пример кода из списка документов. Предоставлено @jperasmus

<script src="//unpkg.com/docsify-copy-code"></script>

Смотрите здесь для больших подробностей.

Disqus

Disqus комментарии. https://disqus.com/

<script>
  window.$docsify = {
    disqus: 'shortname'
  }
</script>
<script src="//unpkg.com/docsify/lib/plugins/disqus.min.js"></script>

Gitalk

Gitalk представляет собой современный компонент комментариев, основанный на Github Issue и Preact.

<link rel="stylesheet" href="//unpkg.com/gitalk/dist/gitalk.css">

<script src="//unpkg.com/docsify/lib/plugins/gitalk.min.js"></script>
<script src="//unpkg.com/gitalk/dist/gitalk.min.js"></script>
<script>
  const gitalk = new Gitalk({
    clientID: 'Github Application Client ID',
    clientSecret: 'Github Application Client Secret',
    repo: 'Github repo',
    owner: 'Github repo owner',
    admin: ['Github repo collaborators, only these guys can initialize github issues'],
    // facebook-like distraction free mode
    distractionFreeMode: false
  })
</script>

Навигация

Пагинатор для docsify. От @imyelo

<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
<script src="//unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>

codefund

плагин легко объединяет с codefund

codefund ранее известен как "codeponsor"

<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>

window.$docsify = {
  plugins: [
    DocsifyCodefund.create('xxxx-xxx-xxx') // change to your codefund id
  ]
}