[go: up one dir, main page]

DEV Community

Cover image for Introducing Markdown GitHub Stars Updater
Stanislav Deviatov
Stanislav Deviatov

Posted on

Introducing Markdown GitHub Stars Updater

We're excited to present to you a powerful tool that simplifies the process of updating your Markdown files with accurate GitHub star counts. Introducing the Markdown GitHub Stars Updater – a Go program designed to seamlessly integrate star counts into your GitHub repository links within your Markdown documentation.

Example

Before running the Markdown GitHub Stars Updater, your Markdown file might look like this:

APITree - A tool for managing and sharing API specifications...
DapperDox - An open-source API documentation generator...
OpenAPI Explorer - A tool for generating user interfaces...
RapiDoc - A tool that generates customizable, interactive...
Redoc - An open-source tool for generating documentation...
Enter fullscreen mode Exit fullscreen mode

After processing with our program, it transforms into:

APITree - A tool for managing and sharing API specifications...
DapperDox (⭐377) - An open-source API documentation generator...
OpenAPI Explorer (⭐213) - A tool for generating user interfaces...
RapiDoc (⭐1.3k) - A tool that generates customizable, interactive...
Redoc (⭐20k) - An open-source tool for generating documentation...
Enter fullscreen mode Exit fullscreen mode

Usage

Updating your Markdown files with star counts has never been easier:

  1. Build from sources
  • Clone the repository:
git clone https://github.com/stn1slv/markdown-github-stars-updater.git
cd markdown-github-stars-updater
Enter fullscreen mode Exit fullscreen mode
  • Build and run the program:
go build
./markdown-github-stars-updater path/to/your/markdown/file.md
Enter fullscreen mode Exit fullscreen mode

Make sure to replace path/to/your/markdown/file.md with the actual path to your Markdown file.

  1. Download Compiled

The latest compiled version can be found in the releases section of the repository.

  1. GitHub Actions Pipeline

Check out our GitHub Actions pipeline example for seamless integration into your projects.

Description

The Markdown GitHub Stars Updater leverages the GitHub API to fetch accurate star counts for your GitHub repositories and automatically integrates them into your Markdown files. Our program provides a user-friendly star count format, catering to different star counts:

  • If the star count is less than 1000, the exact star count is displayed as "⭐35".
  • If the star count falls between 1000 and 9999, it's represented as "⭐1.1k" for 1100 stars.
  • For star counts of 10000 or more, the format changes to "⭐10k" for 10000 stars.

Say goodbye to manual star count updates and hello to effortlessly accurate and updated Markdown files with Markdown GitHub Stars Updater. Try it out today and make your Markdown documentation shine! ✨

Get started now by visiting our repository: https://github.com/stn1slv/markdown-github-stars-updater

Top comments (0)