Displaying 1 to 20 from 66 results

doctoc - 📜 Generates table of contents for markdown files inside local git repository

  •    Javascript

Generates table of contents for markdown files inside local git repository. Links are compatible with anchors generated by github or other sites via a command line flag. In its simplest usage, you can pass one or more files or folders to the doctoc command. This will update the TOCs of each file specified as well as of each markdown file found by recursively searching each folder. Below are some examples.

standard-readme - Standard Readme Style

  •    Shell

Standard Readme is designed for open source libraries. Although it’s historically made for Node and npm projects, it also applies to libraries in other languages and package managers. Standard Readme started with the issue originally posed by @maxogden over at feross/standard in this issue, about whether or not a tool to standardize readmes would be useful. A lot of that discussion ended up in zcei's standard-readme repository. While working on maintaining the IPFS repositories, I needed a way to standardize Readmes across that organization. This specification started as a result of that.

awesome-readme - A curated list of awesome READMEs

  •    

Elements in beautiful READMEs include, but are not limited to: images, screenshots, GIFs, text formatting, etc. Contributions are always welcome! Please read the contribution guidelines first.

feedmereadmes - Free README editing+feedback to make your open-source projects grow

  •    

Go here for relevant articles, talks, and projects that we find inspiring. Add your own favorites via pull request. Even if you don't agree with Preston-Warner, you can still make your READMEs user-friendlier. Feedmereadmes is here to help. We define "user" to include non-developers and aim to tell compelling stories. "[C]ode isn't self-documenting" is one of our mantras, as per Mike Jang's 2015 OSCON talk offering Ten Steps to Better READMEs.




zalando-howto-open-source - Open Source guidance from Zalando, Europe's largest online fashion platform

  •    

A guide to releasing an open-source project at Zalando, Europe's largest online fashion platform. Please feel free to use this as a template for your own organization's open source planning, policymaking, and development efforts. If there's a topic we've missed, or if you have any suggestions for making this better, let us know via our Issues tracker.We're really grateful to Software Lead Weekly, cron.weekly, Chris Aniszczyk (TODO Group), the folks at Datio Engineering, Thomas Lockney of Nike, Jamie Allen at Starbucks, Richard Seroter at Pivotal, Peter Zaitsev at Percona, Jonathan Lipps at Sauce Labs, and others for spreading the word about this doc.

go-advices - List of advices and tricks in the Go's world \ʕ◔ϖ◔ʔ/

  •    Go

List of advices and tricks in the Go's world \ʕ◔ϖ◔ʔ/

awesome_bot - :white_check_mark: Validate links in awesome projects

  •    Ruby

awesome_bot checks for valid URLs in a file, it can be used to verify pull requests updating a README. You can check multiple files (comma separated or * pattern, look below for details).


badgen-service - Fast svg badge generating service

  •    Javascript

Home of badgen.net, fast badge generating service. Then, logically, Badgen Service was born. I had a good time with shields.io, but as time goes by Shields gets slower, leaves more and more broken badges in READMEs. Badgen is trying to be a fast alternative with simplicity and flexibility. Its codebase is simple (2K LoCs vs Shields' 22K LoCs), well structured and fun to develop - it is pretty easy to add badge(s) for new service(s).

hall-of-fame - :trophy: Show some love to your contributors! A widget for your repo README

  •    Python

Hall-of-fame helps you show some love to your contributors. It automatically highlights your new, trending, and top contributors, and updates every hour. You can put this widget anywhere inside your README, e.g. to "Contributing" section. No maintenance is required. Every hour, Hall-of-fame looks into recent commits of your repo using GitHub API. It then selects three categories of contributors: new (those who made their first commit to your repo in the last 7 days), trending (those with most commits in the last 7 days), and top (those with most commits of all time). It then selects up to three new contributors, up to 4 trending contributors, and if total is less than 7, it fill up the remaining spots with top contributors.

badgen - Fast handcraft svg badge generator.

  •    Javascript

Fast handcraft svg badge generator. Used on badgen.net.

Read: a "GNU Make"-like utility for viewing Readme files

  •    C

Read is a simple program to easily load and read README files on a UNIX-compliant system. It works in a similar way to GNU Make by searching a directory for a compatible file, in this case a Readme file, and loading it for reading using a text editor or viewer.

frankenstein - :octocat: Correct README Redirects

  •    Ruby

This project uses awesome_bot to validate links. frankenstein can open a pull request to update README links based on HTTP redirects (this requires credentials set in .netrc).

MarkdownView-Android - MarkdownView is an Android webview with the capability of loading Markdown text or file and display it as HTML, it extends Android webview

  •    Javascript

MarkdownView is a simple library that helps you display Markdown text or files on Android as a html page just like Github. Its really simple to integrate MarkdownView in android. All you need to do make the following change to you build gradle under the app module.

rebecca - Rebecca is a readme generator for Go

  •    Go

Rebecca is a readme generator.Managing the GitHub readme for your Go project can be a drag. When creating jennifer I found examples copied into the markdown would get out of date, and documentation was duplicated. I created rebecca to solve this: see README.md.tpl in the jennifer repo for a real world example.

docor - a smart and tiny README maker using default manifest package.json

  •    Perl

The very first, Ensure excutes docor in directory where contains one manifest file in support manifest files. As a cli tool, Docor will create these files: README.md ,license .gitignore and .npmignore.The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

node-readme - Generate your JS project README.md using an ES6 template

  •    Javascript

Then run npm run readme to generate your README.md.You can copy and customize the default README template and add it to your project as .README.md.

jekyll-readme-index - A Jekyll plugin to render a project's README as the site's index.

  •    Ruby

A Jekyll plugin to render a project's README as the site's index. If you have a readme file, and your site doesn't otherwise have an index file, this plugin instructs Jekyll to use the readme as the site's index. That's it. No more, no less.

github-markdown-toc.go - Easy TOC creation for GitHub README.md (in go)

  •    Go

This is a golang based implementation of the github-markdown-toc tool.Attention: gh-md-toc is able to work properly only if your machine is connected to the Internet.