Создание сайта для документации API с использованием Gulp, Jekyll и markdow
Я создаю сайт для документации API, используя Gulp, Jekyll и markdown.
У меня есть два раздела API, такие как пользователи и роли, каждый из которых имеет следующие конечные точки API:
- Список полей ресурса
- Список всех предметов
- Посмотреть один элемент
- Создать новый предмет
- Обновить элемент
- Удалить пункт
Для достижения этого я создал файлы под
пользователи /_posts/YYYY-MM-DD-ALL_FILE_NAME.markdown
Роли /_posts/YYYY-MM-DD-ALL_FILE_NAME.markdown
в обеих папках _posts я создал шесть файлов по одному для каждой конечной точки API (всего 12 файлов в папке _post). Это помогло мне создать левую навигацию (два заголовка пользователей и ролей и шесть-шесть подзаголовков для конечной точки API выше) и сделать так, чтобы контент для обоих разделов и автоматическая прокрутка также работали.
СЕЙЧАС мой вопрос: как я могу получить ту же функциональность, создав только два файла вместо 12 отдельных файлов?
users / _posts / YYYY-MM-DD-users.markdown (содержит все шесть содержимого конечных точек для пользователей)
role /_posts/YYYY-MM-DD-role.markdown (содержит все шесть содержимого конечных точек для ролей)