Публикации по теме 'mkdocs'
Документирование вашей модели машинного обучения, реализованной с помощью FastAPI
Хорошая документация о том, как работает ваше приложение для машинного обучения, почти так же важна, как и само приложение, другие инженеры или ученые должны понимать, как оно работает, чтобы использовать его.
Сегодня я не буду говорить о том, как написать отличную документацию для вашей высокопроизводительной модели. Вместо этого я дам вам несколько советов, как быстро создать потрясающую документацию для вашего проекта, смешав два моих любимых фреймворка/инструмента: FastAPI (..
Как задокументировать проект с помощью MkDocs 📹
Привет,
Добро пожаловать в мой третий видеоурок, на этот раз о том, как начать работу с MkDocs .
В этом видео я попытаюсь дать вам базовый обзор MkDocs и конфигурацию, состоящую из темы материала и плагина поиска.
Конфигурация
Конфигурация MkDocs, используемая в видео.
site_name: My Cool Project Documentation theme: name: material features: - search.suggest - search.highlight - content.tabs.link plugins: - search nav: - Introduction: "index.md" - Tutorial: - Tutorial..
Вопросы по теме 'mkdocs'
Документы API хостинга, созданные с помощью mkdocs по URL-адресу в проекте Django
Я обычно пишу документацию по API в Markdown и создаю статический сайт с помощью MkDocs. Однако сайт, на котором я хотел бы разместить документацию, - это сайт Django. Итак, мой вопрос, и я, кажется, не могу найти ответ в Google: как мне разместить...
1236 просмотров
schedule
16.03.2023
Как использовать сторонние плагины\расширения Python?
Я прочитал документы что только несколько плагинов предварительно установлены в виртуальной среде, где происходит сборка. Как я могу использовать службу чтения документов с пользовательскими плагинами?
Я использую mkdocs для создания небольшой...
448 просмотров
schedule
18.02.2023
Как я могу использовать Mkdocs на локальном компьютере без сервера?
Я установил Mkdocs (Python 3.6.5) и редактировал и создавал файлы Markdown.
Я попытался открыть основной файл index.html в браузере, но не могу напрямую открывать страницы HTML, связанные с другими файлами HTML.
Используя командную строку и...
932 просмотров
schedule
07.03.2023
Локальный mathjax с mkdocs
Я хотел бы использовать MathJax с Mkdocs на компьютере, у которого нет доступа к Интернету, поэтому я не могу просто позвонить в CDN Mathjax.
Конфигурация
mkdocs.yml :
site_name: My Docs
extra_javascript:
-...
395 просмотров
schedule
28.03.2023
Разрешить CORS в локальной сборке mkdocs (Не удалось загрузить файл ‹:› Запросы с перекрестным происхождением поддерживаются только для схем http, data, chrome, chrome-extension, https)
У меня возникла проблема с font-awesome и search_index.json при локальном создании mkdocs с mkdocs build . Я понимаю проблему и почему она не работает, но я пытаюсь распространять свою документацию локально, а не использовать веб-сервер, поэтому...
175 просмотров
schedule
26.05.2024
Какой шаблон уценки мне нужен, чтобы выходные ячейки в записных книжках Jupyter отличались от входных ячеек при экспорте с помощью nbconvert
Я пытаюсь использовать mkdocs с mknotebooks , чтобы создать веб-сайт из Jupyter Notebook и файлов разметки. Все работает хорошо, за исключением того, что внешний вид ячеек ввода и вывода на результирующих html-страницах идентичен, что затрудняет...
732 просмотров
schedule
25.06.2022
Использование дополнительного файла CSS с Mkdocs, размещенным на ReadTheDocs
Я написал несколько пользовательских CSS, которые я хотел бы включить на сайт Mkdocs, размещенный на ReadTheDocs. Это не работает, потому что RTD не обслуживает файл CSS.
У меня есть .readthedocs.yml файл, который просит RTD использовать Mkdocs:...
642 просмотров
schedule
15.06.2023
Изменение блоков кода mkdocs с помощью настраиваемой темы
Я пытаюсь добавить некоторые элементы html (например, div) в настраиваемую тему, которые обертывают сгенерированные mkdocs блоки кода из вывода html.
mkdocs имеет свои изолированные блоки кода с тройными обратными кавычками ``` stuff ``` , и когда...
269 просмотров
schedule
13.03.2024
ОШИБКА. Значение конфигурации: «тема». Ошибка: Неопознанное имя темы:
Решение подобных проблем на Github по этому поводу указывает на установку MkDocs или темы с помощью менеджера пакетов, а не pip. Однако я установил оба с помощью pip.
Установил MkDocs с помощью pip (не менеджер пакетов)
Установлено n тем...
683 просмотров
schedule
28.03.2022
Можно ли в MkDocs / Material разместить оглавление слева?
Я использую MkDocs с темой Material. Я хотел бы создать сайт, который немного напоминал бы документацию Stripe API.
По умолчанию тема «Материал» помещает документы .md на боковую панель слева, а заголовки с этими документами - на боковой панели...
1770 просмотров
schedule
09.11.2022
Есть ли место, где можно найти файлы CSS для настройки темы материалов MkDocs?
В настоящее время я использую MkDocs вместе с темой материала, чтобы создавать красивые вики-страницы и страницы документации. Однако я хотел бы настроить тему, чтобы сделать ее в целом темнее, так как я не большой поклонник ярких белых фонов. Но, к...
128 просмотров
schedule
20.03.2023
Как я могу использовать кодехилит и русалку вместе?
Мы генерируем документацию с помощью mkdocs с темой материала и до сих пор использовали расширение codehilite. Я добавил русалку, используя метод, описанный здесь: https://github.com/squidfunk/mkdocs-material/issues/693 .
Во-первых, моя уценка:...
440 просмотров
schedule
11.05.2022
Как сделать так, чтобы azure devops не рассматривал информацию и предупреждения как ошибки?
Я работаю над лазурным конвейером devops, созданным без YAML. В конвейере node.js и npm используются для создания некоторых веб-интерфейсов. mkdocs используется для создания веб-документации. Моя проблема в том, что azure devops обрабатывает...
417 просмотров
schedule
24.04.2023
MKdocs не принимает во внимание метаданные (предварительную информацию) при поиске?
Структура моего md файла:
---
title: Mango
subtitle: King of Fruits
tags: [fruit, sweet, tasty]
---
Mango is a very tasty fruit.
## Juice
Juice can be made from mango
Когда я ищу в сгенерированном документе, я не получаю никаких результатов...
76 просмотров
schedule
08.06.2024
Как сделать страницы в боковом меню MkDocs расширяемыми?
Я попытался найти это, но не смог получить никакого ответа, который указывал бы на решение. Я полагаю, сначала позвольте мне начать с некоторой предыстории.
Моя цель :
В настоящее время я выясняю, как получить приличную автоматизированную...
204 просмотров
schedule
12.10.2023