Тестирование сниппетов
- Добавить информацию из файла целиком. Например, git.md.
- Добавить кусочек текста между заголовками.
- Добавить отдельный абзац.
Файл целиком¶
Работа с Git¶
Создание ветки¶
- Откройте терминал и выполните команду:
git branch
. Появится список веток, выделена текущая ветка. - Если текущая ветка – master, создайте ветку:
git checkout -b имя-новой-ветки
. Если текущая ветка – не master, переключитесь в основную ветку:git checkout master
и создайте новую.
Отправка изменений в Github¶
-
Сохраните изменения всех файлов:
git add -A
-
Зафиксируйте изменения:
git commit -m "ваше сообщение"
-
Отправьте изменения в репозиторий:
git push origin название-текущей-ветки
-
Откройте репозиторий в Github.
- Перейдите на закладку Pull requests и нажмите на кнопку New pull request.
- Чтобы принять пулл реквест, нажмите на кнопку Create Pull Request.
- Чтобы слить изменения в ветку master, нажмите на кнопку Merge pull request.
- Нажмите на кнопку Confirm merge.
Актуализация локального репозитория¶
-
В локальном репозитории перейдите в ветку master:
git checkout master
-
Загрузите изменения из ветки master мастер-репозитория:
git pull my-project master
-
Отправьте изменения из своей ветки master в ваш форк на GitHub:
git push origin master
Теперь форк и оригинальный репозиторий находятся в актуальном состоянии.
Текст между заголовками¶
Создание проекта Foliant¶
- В командной строке перейдите в папку, в которой будет создан проект Foliant.
-
Создайте проект:
foliant init
-
Укажите имя проекта, например, "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.
Абзац¶
Для работы с Markdown можно использовать любой текстовый редактор.