#tw_api_jekyll
Привет, как договорились выше, начинаем знакомство с Jekyll и Liquid на практике. Это и серия других постов по теме будут помечены тегом #tw_api_jekyll. В рамках серии постов мы попробуем наладить сборку сайта-справочника API из спецификации в формате OpenAPI.
Сегодня мы подготовим «почву» для нашего справочника.
Для этого выполните следующее:
1. Установите себе на компьютер Jekyll и все зависимости по инструкции для вашей ОС со страницы Installation документации этого SSG (приобнял пользователей Windows — у вас самая длинная инструкция ).
2. Создайте на своем компьютере новый проект с помощью команды (в терминале, консоли).
jekyll new tw_api_jekyll
Здесь вместо tw_api_jekyll можно использовать любое другое имя. Это — имя папки, в которой будет создан новый проект (сайт). Чтобы у нас с вами не было «рассинхрона», предлагаю оставить его как есть.
3. После этого перейдите в созданную папку:
cd new tw_api_jekyll
4. Запустите сайт командой:
bundle exec jekyll serve
Если все сделано правильно, сайт с настройками по умолчанию будет доступен по адресу http://localhost:4000.
Откройте папку tw_api_jekyll в файловом менеджере, в IDE или посмотрите ее структуру в консоли (как вам удобно). Вы увидите следующую картину:
tw_api_jekyll /
├── _posts/ # Папка для постов
├── _site/ # Папка со сгенерированными страницами сайта
├── Gemfile # Файл зависимостей Ruby
├── Gemfile.lock # Конкретные версии зависимостей (генерируется автоматически)
├── _config.yml # Основной конфигурационный файл
├── .jekyll-cache/ # Кеш для ускорения сборки
├── 404.html # Шаблон для станицы 404
├── about.markdown # Страница about
└── index.markdown # Главная страница
Давайте внесем в эту структуру некоторые изменения, чтобы адаптировать сайт под наши нужды.
Сделайте следующее:
1. Удалите папку _posts/ и файл about.markdown. Это мы делаем потому, что наш сайт-справочник API будет одностраничным.
2. Переименуйте файл index.markdown в index.md. Делать это не обязательно, с обоими разрешениями Jekyll работает без проблем. Давайте считать это вкусовщиной: просто я привык использовать для Markdown-файлов расширение .md.
3. Откройте файл index.md и во фронтметтре (это фрагмент вверху страницы, заключенный в ---`) удалите привязку к стандартному шаблону. Для этого удалите `layout: home (или закомментируйте, это нам в будущем понадобится).
4. В начало файла index.md добавьте заголовок # Справочник TW_api. Сохраните файл.
Если все сделали правильно, по адресу http://localhost:4000 будет находиться страница с заголовком # Справочник TW_api без какой-либо разметки (т.к. мы «отвязались» от стандартного шаблона).
На сегодня все. «Почва» для дальнейшей работы готова. В следующий раз мы добавим свой шаблон для сайта-справочника API и спецификацию, из которой он будет собираться.
Привет, как договорились выше, начинаем знакомство с Jekyll и Liquid на практике. Это и серия других постов по теме будут помечены тегом #tw_api_jekyll. В рамках серии постов мы попробуем наладить сборку сайта-справочника API из спецификации в формате OpenAPI.
Сегодня мы подготовим «почву» для нашего справочника.
Для этого выполните следующее:
1. Установите себе на компьютер Jekyll и все зависимости по инструкции для вашей ОС со страницы Installation документации этого SSG (приобнял пользователей Windows — у вас самая длинная инструкция ).
2. Создайте на своем компьютере новый проект с помощью команды (в терминале, консоли).
jekyll new tw_api_jekyll
Здесь вместо tw_api_jekyll можно использовать любое другое имя. Это — имя папки, в которой будет создан новый проект (сайт). Чтобы у нас с вами не было «рассинхрона», предлагаю оставить его как есть.
3. После этого перейдите в созданную папку:
cd new tw_api_jekyll
4. Запустите сайт командой:
bundle exec jekyll serve
Если все сделано правильно, сайт с настройками по умолчанию будет доступен по адресу http://localhost:4000.
Откройте папку tw_api_jekyll в файловом менеджере, в IDE или посмотрите ее структуру в консоли (как вам удобно). Вы увидите следующую картину:
tw_api_jekyll /
├── _posts/ # Папка для постов
├── _site/ # Папка со сгенерированными страницами сайта
├── Gemfile # Файл зависимостей Ruby
├── Gemfile.lock # Конкретные версии зависимостей (генерируется автоматически)
├── _config.yml # Основной конфигурационный файл
├── .jekyll-cache/ # Кеш для ускорения сборки
├── 404.html # Шаблон для станицы 404
├── about.markdown # Страница about
└── index.markdown # Главная страница
Давайте внесем в эту структуру некоторые изменения, чтобы адаптировать сайт под наши нужды.
Сделайте следующее:
1. Удалите папку _posts/ и файл about.markdown. Это мы делаем потому, что наш сайт-справочник API будет одностраничным.
2. Переименуйте файл index.markdown в index.md. Делать это не обязательно, с обоими разрешениями Jekyll работает без проблем. Давайте считать это вкусовщиной: просто я привык использовать для Markdown-файлов расширение .md.
3. Откройте файл index.md и во фронтметтре (это фрагмент вверху страницы, заключенный в ---`) удалите привязку к стандартному шаблону. Для этого удалите `layout: home (или закомментируйте, это нам в будущем понадобится).
4. В начало файла index.md добавьте заголовок # Справочник TW_api. Сохраните файл.
Если все сделали правильно, по адресу http://localhost:4000 будет находиться страница с заголовком # Справочник TW_api без какой-либо разметки (т.к. мы «отвязались» от стандартного шаблона).
На сегодня все. «Почва» для дальнейшей работы готова. В следующий раз мы добавим свой шаблон для сайта-справочника API и спецификацию, из которой он будет собираться.