Вот начало серии постов, которые объяснят, как создать свой собственный проект документации с MKDOCS. Для тех, кто не знает, что такое MkDocs. MKDOCS – это статический генератор сайта (SSG), разработанный в Python, который позволяет всем быстро создавать веб-сайты; Исходные файлы записываются в Markdown, а конфигурация управляется файлами YAML.
Прежде всего, нам нужно запустить наши проект MKDOCS IS Установите Python и Настроить Pip Отказ
Установите MKDOCS с PIP:
python -m pip install mkdocs --user
Убедитесь, что MKDOCS был правильно установлен:
$ mkdocs --version mkdocs, version 1.1.2 from /home/cosckoya/.local/lib/python3.8/site-packages/mkdocs (Python 3.8)
Время вечеринки! К настоящему времени MKDOCS уже установлен, и мы можем создать новый проект со следующей командой:
mkdocs new my-mkdocs-project cd my-mkdocs-project
К настоящему времени вы можете создать и проверить проект базового шаблона, чтобы сделать это просто запустить:
mkdocs build --clean mkdocs serve
Эта команда покажет следующее сообщение:
Serving on http://127.0.0.1:8000
И открытие этого URL увидит ваш проект MKDOCS:)
Но что произойдет, если вы хотите создать онлайн-проект MKDOCS? Вы можете использовать много разных статических провайдеров веб-сайтов, таких как AWS S3, Firebase Google Firebase, Azure Static Webouse … Много вариантов, быстрый для меня – это публиковать его на сайте страниц GitHub.
Для этого мы должны создать новый репозиторий GitHub, как мой: https://github.com/cosckoya/wiki Отказ В «главной» ветве мы будем поддерживать проект MKDOCS, а в филиале «GH-PAGES» стало статическим содержанием MKDOCS, это будет сгенерировано с помощью команды «MKDOCS Build».
Мы должны инициализировать репозиторий с папкой базового проекта:
Вот вещь. Мы можем разработать наш проект MKDOCS: добавьте несколько шаблонов, веб-контент, дополнений или изображений. После проверки того, что на сайте все и после некоторой «сборки и обслуживания»; Мы могли бы развернуть работу сайта:
mkdocs gh-deploy
Затем перейдите на свой сайт страниц GitHub. Мой это это:
· https://cosckoya.github.io/wiki
И это все. Наслаждаться!
Ссылка: · https://www.mkdocs.org · https://pages.github.com.
Оригинал: “https://dev.to/cosckoya/create-your-own-mkdocs-with-github-pages-a5c”