Советы и хитрости, которые вы, вероятно, не знаете с Github Markdown в файлах readme.md

Markdown — это легкий и простой в использовании синтаксис для стилизации всех форм письма на платформе GitHub.

уценка это способ стилизации текста в Интернете. Вы управляете отображением документа; форматирование слов жирным шрифтом или курсивом, добавление изображений и создание списков — вот лишь некоторые из вещей, которые мы можем сделать с помощью Markdown. В основном, Markdown — это обычный текст с несколькими неалфавитными символами, например # или же *,

Вы можете использовать Markdown в большинстве мест вокруг GitHub:

  • гов
  • Комментарии в выпусках и запросах на извлечение
  • Файлы с .md или же .markdown расширение

Встраивание изображений

Есть 2 способа добавить изображения в файл readme.md:

уценка

Используйте следующий синтаксис, чтобы добавить изображение.

![Image of Yaktocat](https://octodex.github.com/images/yaktocat.png)

HTML

Используйте следующий синтаксис, чтобы добавить изображение с помощью HTML.

Фиксированная ширина или высота изображения

Чтобы задать фиксированные размеры изображения, используйте атрибуты width и height. (Помните, что использование html будет действительным только для Github):


Центрирование изображения

Для центрирования изображения мы не будем использовать традиционную разметку, вместо этого мы будем использовать обычный HTML:

Подсветка блока кода

Чтобы выделить фрагмент кода, заключите его в 6 кавычек, за которыми следует название языка. Блоки кода являются частью спецификации Markdown, но подсветка синтаксиса — нет. Тем не менее, многие средства визуализации, такие как Github и Markdown Here, поддерживают подсветку синтаксиса. Какие языки поддерживаются и как эти названия языков должны быть написаны, будет варьироваться от визуализатора к визуализатору.

```javascript
function hello(name) {
console.log(name);
}
```

Emojis

Github Markdown поддерживает встроенные смайлики, посетите страницу смайликов, чтобы увидеть полный список смайликов.

:kissing: :laughing: :neutral_face:

Emojis уценка

Списки задач

Вы можете создать список задач с помощью markdown, который будет преобразован в список флажков. Если вы включите список задач в первый комментарий к проблеме, вы получите удобный индикатор прогресса в вашем списке проблем. Это также работает в Pull Requests.

- [x] @mentions, #refs, [links](), **formatting**, and tags supported
- [x] list syntax required (any unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item

Список прогресса Github

Встраивание Youtube видео

К сожалению, это невозможно до даты. Однако есть небольшая хитрость, которая позволит вам создать изображение и перенаправить пользователя на страницу видео YouTube.

Читайте также:  Как использовать pngquant с PHP

Просто замените YOUTUBE_VIDEO_ID_HERE для идентификатора вашего видео. Изображение появится и будет автоматически перенаправлено на видео в YouTube.


IMAGE ALT TEXT HERE

Или используйте чистую уценку (без размеров):

[![IMAGE ALT TEXT HERE](http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg)](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)

У вас есть еще один совет, который может быть полезен, а у нас его нет в этой коллекции? Пожалуйста, поделитесь им с нами в поле для комментариев.

Ссылка на основную публикацию
Adblock
detector