Описание тега mkdocs

Описание тега Вопросы с тегом
Static site generator geared towards building project documentation
1 ответ

mkdocs: как создать структуру, похожую на папку

Я хочу создать небольшой локальный файл с моими личными конспектами лекций. Структура, которую я хочу, это Индекс 1 (содержит обзор подпапок, но не полное их содержание) Индекс 1.1 (содержит обзор подпапок, но не полное их содержание) Индекс 1.1.1 (…
09 янв '18 в 09:31
1 ответ

mkdocs-pandoc TypeError: _split_row() принимает ровно 2 аргумента (дано 3)

Когда я пытаюсь сгенерировать.pd с помощью mkdocs2pandoc, я получаю следующую ошибку Traceback (most recent call last): File "/usr/bin/mkdocs2pandoc", line 11, in <module> load_entry_point('mkdocs-pandoc==0.2.6', 'console_scripts', 'mkdocs2pan…
10 мар '17 в 11:19
1 ответ

Автоматическая сборка документации Mkdocs в Travis CI

Как именно я могу автоматически развернуть документацию Mkdocs в Travis CI?
16 июн '18 в 21:45
0 ответов

Местный mathjax с mkdocs

Я хотел бы использовать MathJax с Mkdocs на компьютере, который не имеет доступа к Интернету, поэтому я не могу просто позвонить в Mathjax CDN. конфиг mkdocs.yml: site_name: My Docs extra_javascript: - 'javascripts/MathJax-2.7.5/MathJax.js' - 'javas…
03 окт '18 в 09:39
1 ответ

Обратный прокси mkdocs nginx медленный

Я настроил mkdocs и запущен на порту 8000, Nginx настроен как обратный прокси с нижеприведенной конфигурацией. Однако при доступе к сайту через обратный прокси-браузер остается "подключенным..." в течение длительного времени, около 2 минут и загрузк…
09 окт '16 в 02:28
1 ответ

Как добавить постоянные ссылки на узлы дерева в навигационном файле Markdown (mkdocs.yml)?

Навигационный файл mkdocs.yml, с которым я работаю, содержит иерархическое дерево веб-сайта руководств с несколькими категориями и подкатегориями, в которые попадают статьи; дерево является абсолютно виртуальным и не основано на структуре папок / пу…
08 фев '19 в 16:41
1 ответ

Как проверить локально созданные файлы github repo mkdocs в Mac OS X?

Есть репозиторий GitHub, мне нравится вносить изменения в его документы. Он использует readthedocs для размещения и mkdocs для темы. Я использую macOS Mojave. Я нашел это https://docs.readthedocs.io/en/latest/install.html руководство по установке. r…
22 дек '18 в 05:44
1 ответ

Как добавить ссылку на мою главную веб-страницу со страницы, написанной с помощью mkdocs?

Я создаю общий веб-сайт, который также имеет страницу документации. Для страницы документации я использую mkdocs. Мне нужна ссылка на странице документов, в идеале в верхнем правом углу, которая ведет на мою главную веб-страницу. Я знаю, как помести…
18 янв '17 в 23:57
1 ответ

Использование MkDocs с Github

Как использовать mkdocs с github? У меня есть репозиторий, клонированный из основного репозитория. В этом случае, как я толкаю документы (я использую Git на окнах).
09 сен '15 в 21:28
0 ответов

Команда mkdocs не найдена в OSX

Я слежу за процессом установки mkdocs здесь: http://www.mkdocs.org/ Я не могу заставить mkdocs делать что-либо после установки на моей локальной машине. Я установил последнюю версию Python и PIP. Я проверил, установлен ли пакет mkdocs, но все еще ни…
09 фев '16 в 23:50
1 ответ

Как использовать сторонние Python плагины \ расширения?

Я прочитал в документации, что только несколько плагинов предустановлены в virtualenv, где происходит сборка. Как я могу использовать службу чтения документов с пользовательскими плагинами? я использую mkdocs построить небольшую документацию, в mkdo…
13 сен '17 в 07:12
1 ответ

Интеграция формы подписки на рассылку новостей в mkdocs

Я знаю, что mkdocs должен быть статическим сайтом без сторонних интеграций / форм. Мне нужно добавить форму подписки на новостную рассылку на странице, сгенерированной mkdocs. Как я могу это сделать? Там, кажется, 0% информации об этом онлайн.
19 июн '18 в 21:32
3 ответа

Как создать блоки кода с вкладками в Mkdocs или Sphinx?

Есть ли способ создать блоки кода с вкладками, как в Mkdocs или Sphinx?
03 июн '16 в 05:03
0 ответов

Использование mkdocs Github-страницы не обновляются, но ветка gh-pages имеет последние изменения

Есть несколько похожих вопросов, но ни одно из решений, упомянутых в других вопросах, не может решить мою проблему. я использую mkdocs публиковать страницы GitHub. Команда, которую я использую, это mkdocs gh-deploy --clean Это работало правильно в п…
31 авг '16 в 14:32
0 ответов

Gatsby/Hugo/MKDocs для документов уценки в React SPA с динамической функциональностью

Мне нужно создать веб-сайт с динамическими функциями - с поиском и публикацией, а также с получением данных из RESTful API. Мы решили использовать React.js для внешнего интерфейса. Нам также нужна документация в приложении, которая будет написана и …
29 июн '18 в 15:59
1 ответ

Есть ли переменная cachebust в шаблонах mkdocs?

Есть что-нибудь подобное {{ time() }} или даже более идеально {{ sha1sum('main.js') }} который я мог бы использовать в качестве параметра cachebust в моих шаблонах тем? Да, мне известны заголовки кэширования на стороне сервера, но я не могу их контр…
08 дек '17 в 09:41
1 ответ

Как сменить языковой плагин "поиск"?

Я использую Markdown. Есть плагин под названием поиск. В этом плагине поиск слов на русском не работает, но поиск английских слов работает. Как сделать так, чтобы поиск по английским и русским словам работал в этом плагине?
12 июл '18 в 12:39
3 ответа

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

Я хотел бы перечислить заголовки, разделы и подразделы на языке уценки. Так что оглавление будет выглядеть так: 1. Heading1 2. Heading2 2.1 Section1 2.2 Section2 2.2.1 Subsection1 2.2.2 Subsection2 Я использую MKDOCS для создания своих статических в…
29 дек '17 в 22:36
0 ответов

MkDocs не работает должным образом с пользовательским путем URL

В настоящее время я использую mkdocs, version 1.0.3 from /usr/local/lib/python2.7/dist-packages/mkdocs (Python 2.7)С mkdocs-material-3.0.4 тема. Я сгенерировал статический сайт с помощью команды mkdocs build и пытается развернуть его. Все файлы сайт…
13 сен '18 в 14:57
2 ответа

Создание содержимого с помощью JavaScript (Netlify Identity): содержимое мигает при медленных соединениях, как загрузить его только после проверки входа в систему?

Я не являюсь разработчиком веб-приложений, и я хотел бы спросить о передовых методах сбора контента с веб-сайтов. Я готовлюсь к развертыванию документации, созданной с помощью mkdocs. Он использует Netlify Identity, потому что с этим аутентификация …
15 сен '18 в 14:18