DEV Community

loading...

GitME: A simple README generator for your profile or repo

David
401 profile not authorized
・1 min read

So, I wanted to redo my GitHub README, because my old one didn't look so good, and I wanted my new README to be fancier, like displaying my blog posts, Get my latest commit, etc.

So, I made GitME. A very simple README.md generator. You can use EJS or Nunjucks (hoping to add more soon). You can take data (from like a API) and use it in your templates. You can find more about this here. I tried to make it something like 11ty's data files (in the _data folder) so people that used 11ty could easily use GitME and people who don't use 11ty can easily learn.

How does it work?

  1. GitME will first compile all of the data into one object. Basically scanning the data directory and just merging the exported data into one object so you can use that data in your template file
  2. GitME will read the file and give the data/file to the template engine
  3. GitME will render the Markdown into HTML
  4. GitME will push the rendered README to your repo.

It's just that simple.
Example: https://github.com/aboutdavid
GitHub repo (and more directions):

GitME, the GitHub README generator.

What is GitME?

GitME is a README.md generator built with Node.js and Markdown, and you can render files using EJS, or Nunjucks You can get data from the data folder, such as making requests to an extenal API, generating random numbers, etc.

There are currently two files which the demo uses to set metadata and make sample icons that you can use in your README file like the Node.js icon or the golang icon. You can fnd the full list of icons in data/icons.js.

How does it work?

GitME will render the README.md file, then, GitME will push the rendered README file to your repo using Node.js and GitHub actions.

How do you get started?

  1. Click the “Use this template” on this repo.
  2. Make the repo name Username/Username. For example, if your username is johndoe, then your repo would be called johndoe Note: If…

Discussion (0)

Forem Open with the Forem app