Я сделал лучшее ReadMe на Github!

Убедитесь в этом сами.

AFAIK не существует законных наград для Github ReadMe, возглавляемых людьми и участвующих в голосовании. Но вы сами решите, действительно ли это лучший Github, который вы когда-либо видели.

Вот как вы тоже можете это сделать:

Вводный PNG

Я сделал PNG из программы carbon, в которой вы можете создавать скриншоты своего кода. Вы также можете экспортировать его как SVG, если хотите добавить анимацию или другие настройки в файл.

После экспорта PNG я отредактировал файл в Figma, чтобы добавить пользовательский текст и модель бота.

График вклада змеи


Этот график взят из моего реального графика на github. И змея поедает их, как в классической игре про змею из наших старых добрых телефонов Nokia.
Я использовал этот экшен на github, чтобы сделать его.

Анимированный SVG


Нажмите на анимацию, чтобы получить исходный код. Да! Это не GIF, и да, вы можете анимировать SVG, и это можно использовать для ReadMe.

Типовой SVG генерируется отсюда. Настройте параметры по своему усмотрению.

Статистика маяка


Я взял изображение отсюда. Затем я просто настроил текст в Figma.

Таблицы

Вот лучшие практики для markdown. Здесь вы увидите множество способов создания таблиц и форматирования ReadMe на Github.

Кнопка поддержки


Она была сгенерирована с сайта Ko-fi. Я взял ее из их вкладки виджетов. Оттуда вы можете настроить свою кнопку по своему усмотрению. Я выбрал Ko-Fi, потому что они не берут плату за спонсорство, и вы можете использовать Paypal или Stripe. Конечно, вы также можете заменить эту кнопку на предпочитаемую вами платформу.

Щиты или значки для социальных сайтов

Я использовал сайт shields.io. Они предлагают множество способов настроить внешний вид ваших значков.

Живой поток Spotify

Он показывает мой недавний поток или то, что я слушаю в режиме реального времени. Я использовал вот это. Вам нужно будет авторизоваться в своей учетной записи Spotify. Вы также можете настроить тему.

Автоматически обновляемый рабочий процесс для лент и блога


Этот рабочий процесс перечисляет соскобленные RSS или фиды с любого из моих блогов с разных платформ. Я использовал этот Github Action.

Статистика Github


Я использовал это для их генерации.

![Github Stats of Milk](https://github-readme-stats.vercel.app/api?username=GithubUsername&show_icons=true&theme=buefy)
![Profile Stats of Milk](https://github-readme-stats.vercel.app/api/top-langs/?username=GithubUsername&layout=compact&hide=html&theme=buefy)
Вход в полноэкранный режим Выйти из полноэкранного режима

Просто замените GithubUsername на ваше имя пользователя и все готово.

Значок подсчета посетителей

Вот точный код, используемый для генерации этих значков:

![Visitor Count Badge](https://komarev.com/ghpvc/?username=GithubUsername&label=Profile%20views&color=0e75b6&style=flat)
Войти в полноэкранный режим Выход из полноэкранного режима
![Visitor Count Badge - Classic](https://komarev.com/ghpvc/?username=GithubUsername&label=Profile%20views&color=0e75b6&style=flat)

Войти в полноэкранный режим Выход из полноэкранного режима

Просто замените GithubUsername на свое имя пользователя, и все готово.

Вот еще один способ сделать это. Посмотрите здесь варианты стиля.

Посмотрите другие ReadMe на Github

Вот сайт, где можно посмотреть профили других людей.
Вы также можете найти список инструментов, которые помогут вам создать лучший из возможных Github ReadMe. Существует множество генераторов профилей, которые облегчат вам жизнь.

Наконец, я приватизировал свой github, чтобы моя страница на github выглядела менее загроможденной. Кроме того, это помогает не спамить моих друзей, когда я нахожусь в звездной буре или коммичу и делаю слишком много pull request’ов.
Это бета-версия функции. Попробуйте сами. Она находится в настройках.

milkshakegum (Milk) — GitHub

Одержим идеей создания инструментов, облегчающих повседневную жизнь. #copeFueled with caffeine, ADHD and OCD. — milkshakegum

github.com

Пришло время раскрыть свой творческий потенциал. Удачи! -Milk

Журнал изменений:

Большое спасибо, что оценили мою работу!
Я принял во внимание все отзывы, которые вы мне дали.

  • Добавил правильные теги ALT.
  • Переделал как можно больше HTML в Markdown, если он не будет работать в Markdown, я хотя бы добавил пробелы, чтобы сделать его читабельным.
  • Исправил неправильно написанные слова.
  • Сменил предыдущую тему на более доступную.

Оцените статью
devanswers.ru
Добавить комментарий