DgtlBureau / zarubin_site

https://blog.zarubin.co.uk/
0 stars 0 forks source link

Инструкция по добавлению поста:

  1. Для загрузки поста необходимо зайти в репозиторий https://github.com/DgtlBureau/soccer_blog, перейти по следующим директориям : src/posts Инструкция c описанием директории

  2. В разделе posts справа нажать на “Add file”, и выбрать “Upload files” что бы загрузить необходимые файлы с расширением .md . После выбора откроется окно в котором нужно будет нажать на “choose your files” и выбрать файлы. Так же нужно будет поставить отметку на “Commit directly to the main branch.”

    Инструкция по добавлению файла Инструкция по загрузке файла

  3. Картинка которая будет использоваться в файле должна лежать в директории public/assets/images/post. В файле который загружается в posts должен быть прописан путь к изображению следующим образом: ‘assets/images/post/.png’

    Инструкция по загрузке файла

    ВАЖНО: имя файла картинки не должно содержать пробелы. Вместо пробелов использовать “-” или “\_”
  4. Файл который загружается в posts должен быть размечен согласно Markdown разметке. Так же необходимо что бы были следующие поля в шапке: title, description, image, date.

    Инструкция по заголовкам

    1. titlt: Обязательное поле заголовка поста
    2. description: Обязательное поля для описания поста
    3. image: Путь с указанием где лежит файл фотографии
    4. date: Дата поста в формате "15-05-2024"
    5. readingTime: Поле обязательное для типа "Research"
    6. type: Тип статьи (Notest, Research, Manifesto)
    7. tag: Обязательно е поле для обозначения категории поста ("Product", "Expertise", "Best Practice" и т.д.)
    8. authorName: Поле для указания Ф.И. автора статьи ("Vitaliy Zarubin"). Обязательное для типа "Notest" и "Research". Для остальных можно указать пустым ("")
    9. authorImage: Обязательное поле для типа "Notest" и "Research". Для остальных так же можно указать ("")
    10. downloadLink: Обязательное поле для типа "Research", в котором должен находиться путь к скачиванию файла

      ОБРАТИТЕ ВНИМАНИЕ: Заголовки обернуты в специальные символы ("---"). Это необходимо для того что бы получать необходимые данные при считывании md. файла

  5. Для того что-бы поменять фотографию автора, неодходимо поместить или указать (если фото уже имеется в директории) путь нужной фотографии и дописать информацию об авторе: ‘assets/images/author/.png/jpg....’ Инструкция по добавлению фото автора

  6. Хэштеги которые будут в конце поста необходило обернуть в специальный тег: .... Инструкция по добавлению фото автора

Инструкция по разметке Markdown файлов есть на следующих источниках: https://gist.github.com/Jekins/2bf2d0638163f1294637, https://doka.guide/tools/markdown,

В качестве шаблона можно использовать любой пост изменив в нем необходимое содержимое согласно пунктам перечисленных выше!!!

Thu Apr 25 20:15:54 UTC 2024

Инструкция по добавлению кейсов:

  1. Для загрузки кейса необходимо зайти в репозиторий https://github.com/DgtlBureau/zarubin_site, перейти по следующим директориям : src/cases

    Инструкция c описанием директории

  2. В разделе cases справа нажать на “Add file”, и выбрать “Upload files” что бы загрузить необходимые файлы с расширением .md . После выбора откроется окно в котором нужно будет нажать на “choose your files” и выбрать файлы. Так же нужно будет поставить отметку на “Commit directly to the main branch.”

    Инструкция по добавлению файла Инструкция по загрузке файла

  3. Картинка которая будет использоваться в файле должна лежать в директории public/assets/images/case. В файле который загружается в cases должен быть прописан путь к изображению следующим образом: ‘assets/images/case/.(расширение файла)’. Путь к картинкам должен быть указан в квадратных скобках. Если картинок несколько то указывать их нужно через запятую.

    Инструкция по указанию пути капринки Инструкция по указанию пути капринки

  4. Файл который загружается в cases должен быть размечен согласно Markdown разметке. Так же необходимо что бы были следующие поля в шапке: title, industries, tag, images.

    Инструкция по заголовкам

    1. titlt: Обязательное поле заголовка кейса
    2. industries: Обязательное полe с массивом тегов
    3. tag: обязательное поле с указанием названия кейса
    4. images: массив с изображениями

      ОБРАТИТЕ ВНИМАНИЕ: Заголовки обернуты в специальные символы ("---"). Это необходимо для того что бы получать необходимые данные при считывании md. файла. И все поля заключены в ковычки.

В качестве шаблона можно использовать любой пост изменив в нем необходимое содержимое согласно пунктам перечисленных выше!!!