Изучите эти несколько приемов, чтобы легко выделить свой GitHub

внешний интерфейс GitHub Открытый исходный код
Изучите эти несколько приемов, чтобы легко выделить свой GitHub

Контент, которым я поделился сегодня, я думаю, что каждый друг, который интересуется открытым исходным кодом, знает более или менее, и это также некоторые мощные инструменты, которые я использую в проектах с открытым исходным кодом, которые могут сделать наши проекты с открытым исходным кодом иgithubДомашняя страница более выразительна, и в конце я поделюсь одним из своихgithubдомашняя страницаreadme.md, вы можете обратиться и узнать.

Прочитав эту статью, вы сможете получить:

  • использоватьreadme-md-generatorУкрасить вашREADME.md
  • использоватьgitHub-readme-statsАвтоматически генерировать персональные отчеты статистического анализа
  • использоватьgit-emojiВизуализируйте историю коммитов кода

1. Как сделать так, чтобы у вашего open source проекта был красивый README.md?

Пройдясь по сообществу, Сяо Си обнаружилreadme-md-generator.

readme-md-generatorпутем сканирования нашегоpackage.jsonа такжеgitконфигурация, которая поможет нам создать соответствующийreadmeструктура.

произведеноREADME.mdПодобно следующему отображению:

Кроме того, отличныйpackage.jsonОн должен содержать следующие метаданные:

{
  "name": "H5-Dooring",
  "version": "1.1.3",
  "description": "H5-Dooring是一款功能强大，开源免费的H5可视化页面配置解决方案，致力于提供一套简单方便、专业可靠、无限可能的H5落地页最佳实践。技术栈以react为主， 后台采用nodejs开发。",
  "author": "作者信息",
  "license": "开源协议",
  "homepage": "主页地址",
  "repository": {
    "type": "git",
    "url": "git仓库地址"
  },
  "bugs": {
    "url": "供他人提issue的地址"
  },
  "engines": {
    "npm": ">=5.5.0",
    "node": ">=9.3.0"
  }
}

Когда вы работаете над проектами с открытым исходным кодом, вы также можете обратиться к приведенным выше спецификациям, чтобы сделать ваши проекты с открытым исходным кодом более надежными и красивыми.Далее я поделюсь одним, созданным с помощью этого инструмента.readme.mdЭффект:

адрес:mitu-editor | Легкий и мощный фоторедактор

2. Используйтеgithub-readme-statsАвтоматически генерировать персональные отчеты статистического анализа

мы все знаемgithubПрофиль конфигурации по умолчанию очень однообразен, но мы видим много старшего брата.github Домашняя страница очень красивая, например вот эта:

Почему это?Честно говоря, здоровяк на картинке выше просто придумал украшениеперсональная домашняя страница на гитхабеАвтор инструмента, мы видим, что его личная домашняя страница имеет очень красивый статистический график, и инструмент, который генерирует этот динамический статистический график,github-readme-stats, Его можно найти в нашемREADMEполучать динамически генерируемыеGitHubСтатистика и наш метод использования также очень просты, просто нужноgithubдомашняя страницаREADMEДобавьте следующий код в:

[![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)

нам просто нужно изменить?username=ценность нашего собственногоGitHubДостаточно имени пользователя.

Настройте свою собственную тему статистики

В то же время мы также можем легко настроить тему карточки статистики, тема по умолчанию, предоставляемая инструментом, выглядит следующим образом:

Точно так же нам нужно толькоREADMEДобавьте следующий код в:

![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical)

Таким образом, вы можете легко выбрать тему, которая вам нравится. Что еще более полезно, так это то, что мы также можем настроить цвет темы.githubИспытайте это на себе.

Добавляйте популярные языковые карточки для своих проектов

Карта популярных языков показывает, где мы находимсяGitHubЯзыки программирования, обычно используемые в проектах с открытым исходным кодом в Интернете, показаны следующим образом:

Конечно, его также можно настроить на компактную компоновку:

Добиться такого эффекта тоже очень просто, нужно только настроить следующий код:

[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=compact)](https://github.com/anuraghazra/github-readme-stats)

Другие конфигурации можно найти наgithubКопайте медленно, проектgithubАдрес следующий:

github-readme-stats

Здесь я также показываю, что я настроил послеgithubЭффект интерфейса персональной домашней страницы:

3. Используйте git-emoji для визуализации коммитов кода

git-emojiдаgitпредставленная информацияemojiРуководства, которые мы представляем в соответствии со своими спецификациямиloglog будет сгенерировано простое для понимания выражение отправки, как показано ниже:

Более известные проекты с открытым исходным кодом, которые мы видим, будут содержать изображения.emoji, Он также должен следовать соответствующим спецификациям, представленным на его вводном веб-сайте:

Интернет-адрес:gitmoji.js.org/

Мы можем использовать его рекомендации, чтобы легко оптимизировать наши коммиты с открытым исходным кодом.log, иди и попробуй сейчас~

наконец

Здесь я делюсь тем, что я настроилgithub READMEШаблон, вы можете обратиться к:Украсьте свой профиль на github, более практичные проекты и фреймворки с открытым исходным кодом в визуализации данных и инжиниринге я выведу позже.Если у вас есть другие вопросы или потребности, вы можете обменяться и поучиться у автора.

Если эта статья была вам полезна, я надеюсь передать ее автору.Нравится + ИзбранноеТаким образом, автору предлагается продолжать создавать хардкорные статьи. Вы также можете подписаться на официальный аккаунт автораИнтересный разговор о фронтендеПервый раз, чтобы нажать интерфейс хороший текст.

Категории