Skip to content

Подготовка рабочего места

О Wiki

Подготовка рабочего места

Для разработки статей и публикации на текущем сервисе Вам потребуется:

  • Наличие доступа к https://repo.ks-sakh.ru/mkdocs/mkdocs
  • Установленные локально:
    • Git-клиент (например: GitHub Client)
    • Python
    • pip
    • MkDocs
    • Текстовый или markdown редактор

Установка Python, pip и MkDocs требуется для запуска локальной копии данного сервиса, для дальнейшей возможности предварительного просмотра результата вёрстки создаваемой/редактируемой документации.

Установка компонентов

Для подготовки рабочего места, нужно сделать несколько простых действий, в прямой последовательности:

1. Установить python

  • В первом окне мастера отметить "Add Python 3.5 to PATH" и нажать "Customize installation"
  • Во втором окне "Optional Featuteres" оставить как есть и нажать "Next"
  • В окне "Advanced Options" отметить (если не отмечен) Install for all users, остальное оставить как есть и нажать кнопку "Install"
  • Начнется процесс установки
  • После успешного завершения установки отобразиться окно "Setup was successful", где надо нажать "Close"

2. Установить pip:

Выполнить в командной строке команду: 

python -m pip install --upgrade pip
Результат будет выглядеть примерно так:

3. Установить mkdocs:

Выполнить в командной строке команду: 

pip install mkdocs
Результат будет выглядеть примерно так:

4. Скачать GitHub Client

  • При первом запуске программа отобразит приветственную страницу в нем надо нажать "Skip this step" В следующем окне укажите свое имя, рабочий e-mail и нажмите "Continue" Далее снимите флажок "Yes, submit periodic usage stat" и нажмите "Finish" Теперь можно указать параметры подключения к репозиторию https://repo.ks-sakh.ru/mkdocs/mkdocs.git и склонировать его к себе.
    Для этого необходимо открыть меню File -> Clone repository...

    и указать параметры подключения

Программа запросит логин/пароль, нужно ввести те что Вы используете для доступа к https://repo.ks-sakh.ru

  • Если по какой-то причине не создался ярлык. Создать ярлык на рабочем столе %LOCALAPPDATA%\GitHubDesktop\GitHubDesktop.exe

GitHub Client - далее в работе:

  • для загрузки себе последней редакции репозитория необходимо выбрать меню Reposytory -> Pull
  • для публикации изменений в репозиторий необходимо ввести краткое наименование в поле "Summary (required)" и нажать "Commit to..." после чего нужно выбрать меню Repository => Push

Установка поддержки темы на локальный сервис

  • Перед запуском локального сервиса, выполнить в командной строке: 
    pip install mkdocs-material

Запуск локального сервиса

  • в командной строке перемещаемся в каталог с клоном репозитория и выполняем запуск сервиса командой вида: 
    cd "<Путь до каталога с клоном>":
mkdocs serve

При регулярном использовании рекомендуется сделать bat-файл

Редакторы

В качестве редактора можно использовать любой текстовый редактор, например: notpad++

Также есть markdown редакторы (например haroopad), имеющие функцию предпросмотра, Но необходимо учитывыть, что они обеспечивают предпросмотр только базовой разметки markdown.