/markdown-github-status

Update github statuses form awesome MD

Primary LanguageJavaScriptMIT LicenseMIT

markdown-github-status

Update awesome markdowns github statuses

Watched repos

  1. awesome-react - React original
  2. awesome-rust - Rust original
  3. awesome-electron - Electron original
  4. awesome-flutter - Flutter original
  5. awesome-vue - Vue original

Updated at 2021-04-05 04:00@UTC

Requirements

  1. Get git installed
  2. Install node.js
  3. Sign up Github account
  • Optional: install yarn

Usage

  1. Clone project git clone https://github.com/eGust/markdown-github-status
  2. Copy config/settings.sample.js to config/settings.js
  3. Add your own token authToken.
  4. Install dependencies with yarn install or npm i
  5. Run it with yarn start or npm start

Several minutes later you should get the formatted markdowns in dist folder.

How to get your own authToken from github.com

  1. Click Generate new token in Settings -> Developer settings -> Personal access tokens
  2. Check gist and click Generate token
  3. Copy and paste to replace YOUR_SECRET_GITHUB_TOKEN with your token

You must read the documentation about github API Rate Limit. Be careful if your markdowns extend the limit (5k req/hour).