Публикации по теме 'mkdocs'


Как использовать PlantUML внутри MkDocs
Mkdocs, PlantUML Как использовать PlantUML внутри MkDocs MkDocs с PlantUML, выигрышная комбинация Всем привет, Это будет краткий пост о проблеме, с которой я столкнулся несколько недель назад. Как и для большинства из вас, документация проекта является важной частью разработки. Плохая документация проекта — плохая идея, потому что: 1. Хорошая документация упрощает понимание проекта 2. Документация указывает на основу проекта 3. Некоторые отвергнутые методологии обычно..

Вопросы по теме 'mkdocs'

Сайт mkdocs открывается некорректно
У меня есть mkdocs.yml файл, который выглядит так: site_name: blabla pages: - One page: page2.md - Second page: page2.md - Navigation: Navigation.md Когда я открываю его, URL-адрес выглядит так:...
125 просмотров
schedule 15.04.2022

Широкие различия таблиц в Chrome и Firefox в mkdocs-материале
Я не особо разбираюсь в html / css / js, но я делаю документацию для одного проекта в MkDocs с Тема материала . Проблема здесь в том, что у меня очень широкие таблицы и они по-разному отображаются в Chrome и Firefox, точнее - в Firefox они...
424 просмотров
schedule 23.01.2023

Как протестировать репозиторий github mkdocs, созданный локально в Mac OS X?
Есть репозиторий GitHub, который мне нравится вносить изменения в его документы . Он использует readthedocs для размещения и mkdocs для темы. Я использую macOS Мохаве. Я нашел это https://docs.readthedocs.io/en/latest/install.html...
173 просмотров
schedule 11.07.2022

Почему мои локальные ссылки HTML идут в родительскую папку, а не в .html?
РЕДАКТИРОВАТЬ: ответ Вейлана помог! Спасибо! Я пытаюсь заархивировать файлы документов .html для отправки клиенту. Цель состоит в том, чтобы получить тот же опыт, что и при навигации по реальному веб-сайту. При открытии файлов .html любая...
315 просмотров
schedule 16.12.2023

Как автоматически добавлять файлы .md в выходной файл (ы) html с помощью mkdocs?
Моя цель - иметь возможность создавать контент, который автоматически добавляется на html-страницы, созданные с помощью mkdocs. Одним из примеров использования этого может быть блог. Решение может потребовать размещения .md файлов в Та же...
207 просмотров
schedule 08.12.2023

Как запретить material-mkdocs обрезать пробелы inlineCodeBlock?
(material-) mkdocs удаляет все пробелы из встроенных кодовых блоков, подобных этому: : , поэтому результат будет выглядеть так : . Я попытался указать язык с помощью shebang - как я думал, это может быть грязный обходной путь - но это не помогло.
22 просмотров
schedule 14.11.2022

jinja2 как получить значение переменной, чтобы использовать его в операторе if jinja2
Для того, чтобы создать шаблон с помощью jinja и уценки через mkdocs. Я столкнулся с этой проблемой, которая блокирует меня до сих пор. Я использую переменную в своем операторе if, чтобы заполнить таблицу определенной информацией, если условие...
29 просмотров
schedule 18.06.2023