Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
 
 
 
 
 
 

README.md

repostatus to markdown

Project Status: Active - The project has reached a stable, usable state and is being actively developed.

Create an overview of your repos statuses by parsing repostatus badges into a single markdown file listing all your repos.

Installation

$ npm install -g repostatus2md

Usage

By default the resulting markdown will be printed to the commandline. This allows to chain rs2md together with other tools. Or you can just save it to a file.

$ rs2dm -t [your token here] > repos.md

rs2dm assumes that you have the status badges in a readme file which live in the top level of your repository. Otherwise a project will be classified as not having a status. In this we do not follow the standard, ignoring repostatus.org files.

Usage: rs2md [options]

  Create a markdown overview of your repos statuses.

  Options:

    -h, --help                 output usage information
    -V, --version              output the version number
    -t, --token <token>        GitHub access token.
    -u, --username <username>  GitHub username.
    -p, --password <password>  GitHub password.
    --include-forks            Include forked repositories.
    --headline-depth <"##">    What typ of headline to use in the markdown.

Authentication

You need to authenticate with GitHub. You can either enter your username and password or generate a token.

Visit /settings/token to generate a new access token. Make sure it has access to your public repos. Copy it when you see it as you will only get to see it once.

About

Create a markdown formatted overview of your repos statuses.

Resources

Releases

No releases published

Packages

No packages published
You can’t perform that action at this time.