Подготовка к работе

• Установка Git
  • Настройка Git
• Установка Foliant и необходимых компонентов
• Создание проекта Foliant
• Создание репозитория

Установка Git

1. Скачайте файл инсталлятора с сайта и установите Git.
2. Откройте терминал и введите команду git --version. Появится информация об установленной версии Git.

Настройка Git

1. Откройте терминал и выполните команды:

   git config --global user.name "профиль"
   git config --global user.e-mail`
   

2. Сгенерируйте SSH-ключ с помощью утилиты Putty. Подробнее см. статью "Как сгенерировать SSH-ключ для доступа на сервер".

3. Откройте профиль на Github и перейдите на страницу "SSH and GPG keys".

4. Нажмите на кнопку New SSH key. Откроется страница:

   

5. Укажите имя ключа в поле Title.

6. Вставьте ключ в поле Key.
7. Нажмите на кнопку Add SSH key.

Установка Foliant и необходимых компонентов

Чтобы установить Foliant и необходимые компоненты:

1. Установите Python.

2. Установите Foliant с помощью pip:

   python -m pip install foliant foliantcontrib.init
   

3. Установите менеджер пакетов Chocolatey.

4. Установите Pandoc с помощью Chocolatey:

   choco install pandoc
   

5. Установите MkDocs:

   pip install mkdocs
   

6. Установите MiKTeX.

7. Установите nodejs.
8. Установите MdToPdf с помощью npm:

   npm install -g md-to-pdf
   

Создание проекта Foliant

1. В командной строке перейдите в папку, в которой будет создан проект Foliant.

2. Создайте проект:

   foliant init
   

3. Укажите имя проекта, например, "Hello Foliant". Появится сообщение:

   Project "Hello Foliant" created in hello-foliant
   

Чтобы посмотреть содержимое проекта, выполните команды:

$ cd hello-foliant
$ tree
.
├── docker-compose.yml
├── Dockerfile
├── foliant.yml
├── README.md
├── requirements.txt
└── src
    └── index.md
1 directory, 6 files

Проект содержит файлы и папки:

• docker-compose.yml и Dockerfile – файлы, необходимые для создания проекта в Docker;
• foliant.yml – конфигурационный файл проекта;
• README.md – файл с информацией о проекте;
• requirements.txt – список пакетов Python, необходимых для проекта: бэкенды и препроцессоры, темы для MkDocs и т.д.;
• src – папка с исходными файлами проекта. По умолчанию в папке создается файл index.xml.

Создание репозитория

Чтобы создать репозиторий на https://github.com/:

1. Зарегистрируйтесь или войдите в свой аккаунт на https://github.com/.

2. Нажмите на кнопку New в колонке Repositories. Откроется окно:

   

3. Укажите название репозитория в поле Repository name.

4. Установите переключатель Public.
5. Не устанавливайте флажок Initialize this repository with a README.
6. Нажмите на кнопку Create repository.
7. Нажмите на кнопку Upload files и загрузите файлы проекта.