27.6K ·GitHub
Что это такое?
Material for MkDocs — это тема оформления и фреймворк на основе MkDocs, который превращает файлы Markdown в профессиональный статический сайт документации с поиском.
Material for MkDocs — это тема оформления и фреймворк на основе MkDocs, который превращает файлы Markdown в профессиональный статический сайт документации с поиском.Это тема для MkDocs или самостоятельный генератор статических сайтов?Это тема и фреймворк, который расширяет MkDocs, а не заменяет его: контент по-прежнему пишется в Markdown, сайт собирает MkDocs, а Material отвечает за оформление, поведение и плагины.
Это тема и фреймворк, который расширяет MkDocs, а не заменяет его: контент по-прежнему пишется в Markdown, сайт собирает MkDocs, а Material отвечает за оформление, поведение и плагины.Как это запустить?Установите через pip, затем добавьте несколько строк в mkdocs.yml, чтобы назначить эту тему.
Установите через pip, затем добавьте несколько строк в mkdocs.yml, чтобы назначить эту тему.Нужно ли сначала установить Python?Да, это пакет Python, который распространяется через pip, поэтому нужна рабочая среда Python и pip.
Да, это пакет Python, который распространяется через pip, поэтому нужна рабочая среда Python и pip.Нужно ли знать HTML, CSS или JavaScript, чтобы этим пользоваться?Нет: проект устроен так, что вы пишете только Markdown и настраиваете YAML, а отрисовку HTML, CSS и JavaScript берёт на себя тема.
Нет: проект устроен так, что вы пишете только Markdown и настраиваете YAML, а отрисовку HTML, CSS и JavaScript берёт на себя тема.Кто уже использует это в продакшене?Этому инструменту доверяют как крупные компании, так и проекты с открытым исходным кодом, включая AWS, Google, Microsoft, Kubernetes, FastAPI и Pydantic.
Этому инструменту доверяют как крупные компании, так и проекты с открытым исходным кодом, включая AWS, Google, Microsoft, Kubernetes, FastAPI и Pydantic.Будет ли сайт документации работать и на телефонах, и на планшетах?Да, тема автоматически подстраивает макет под экраны компьютеров, планшетов и телефонов.
Да, тема автоматически подстраивает макет под экраны компьютеров, планшетов и телефонов.Хранится ли моя документация на стороннем сервисе?Нет: вы сохраняете полное владение исходными файлами и готовой сборкой, поэтому ваш контент не зависит от внешнего сервиса хостинга.
Нет: вы сохраняете полное владение исходными файлами и готовой сборкой, поэтому ваш контент не зависит от внешнего сервиса хостинга.Можно ли изменить оформление сайта?Да, цвета, шрифты, язык, иконки и логотип меняются несколькими строками конфигурации, а тема рассчитана на простое расширение.
Да, цвета, шрифты, язык, иконки и логотип меняются несколькими строками конфигурации, а тема рассчитана на простое расширение.Поддерживает ли она несколько языков для документации?Да, поддерживается более 60 языков для содержимого сайта и поиска.
Да, поддерживается более 60 языков для содержимого сайта и поиска.Есть ли встроенный поиск?Да, в проект входит клиентский поиск на основе lunr и lunr-languages, поэтому документацию можно искать сразу, без сервера.
Да, в проект входит клиентский поиск на основе lunr и lunr-languages, поэтому документацию можно искать сразу, без сервера.Зачем выбирать это, а не обычную тему для MkDocs?Тема оптимизирована по скорости и небольшому размеру, при этом предлагает широкие возможности настройки (цвета, шрифты, иконки). Её активно поддерживают и используют более 50 000 людей и организаций, поэтому набор функций зрелый и проверен временем.
Тема оптимизирована по скорости и небольшому размеру, при этом предлагает широкие возможности настройки (цвета, шрифты, иконки). Её активно поддерживают и используют более 50 000 людей и организаций, поэтому набор функций зрелый и проверен временем.What are similar projects?django-cms, zola, mkdocs, fumadocs, jekyll-theme-chirpy, quarkdown, docz, nextra
django-cms, zola, mkdocs, fumadocs, jekyll-theme-chirpy, quarkdown, docz, nextraWhich topics is it in?content-management, internationalization, documentation-tool, plugins, static-site-generator, material-design, pwa, theme, search, i18n, documentation, markdown
content-management, internationalization, documentation-tool, plugins, static-site-generator, material-design, pwa, theme, search, i18n, documentation, markdown