- Documentation repository

  •        23

The below commands setup your environment for running GitHub pages locally. Any edits you make will be viewable on a lightweight webserver that runs on your local machine. Your copy of the site will then be viewable at: http://localhost:4000 (or wherever Jekyll tells you).



Related Projects

godocdown - Format package documentation (godoc) as GitHub friendly Markdown

  •    Go

-- Command godocdown generates Go documentation in a GitHub-friendly Markdown format. This program is targeted at providing nice-looking documentation for GitHub. With this in mind, it generates GitHub Flavored Markdown ( by default. This can be changed with the use of the "plain" flag to generate standard Markdown.

pkgdown - Generate static html documentation for an R package

  •    R

pkgdown is designed to make it quick and easy to build a website for your package. You can see pkgdown in action at this is the output of pkgdown applied to the latest version of pkgdown. Learn more in vignette("pkgdown") or ?build_site. This will generate a docs/ directory. The home page will be generated from your package’s, and a function reference will be generated from the documentation in the man/ directory. If you are using GitHub, the easiest way to make this your package website is to check into git, then go to settings for your repo and make sure that the GitHub pages source is set to “master branch /docs folder”. Be sure to update the URL on your github repository homepage so others can easily navigate to your new site.

copilot-preview - Documentation for GitHub Copilot

  •    Python

Welcome to the GitHub Copilot user community! In this repository, you can find documentation, walkthroughs, examples, and the latest resources you need to use GitHub Copilot. For a tour of GitHub Copilot, visit the homepage at

swagger2markup - A Swagger to AsciiDoc or Markdown converter to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation

  •    Java

The primary goal of this project is to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation produced by Swagger. The result is intended to be an up-to-date, easy-to-read, on- and offline user guide, comparable to GitHub’s API documentation. The output of Swagger2Markup can be used as an alternative to swagger-ui and can be served as static content. NOTE: The Swagger Specification has been donated to to the Open API Initiative (OAI) and has been renamed to the OpenAPI Specification. Swagger2Markup converts a Swagger JSON or YAML file into several AsciiDoc or GitHub Flavored Markdown documents which can be combined with hand-written documentation. The Swagger source file can be located locally or remotely via HTTP. Swagger2Markup supports the Swagger 1.2 and 2.0 specification. Internally it uses the official swagger-parser and my markup-document-builder. - Easy Python packages creation.

  •    Python

Now you have a new package with a Sphinx documentation and a git repository for your project. And your package has been installed on your computer in develop mode (meaning you can change the code directly from this folder, without needing to reinstall the project). This will link my project to an existing Github repository and initialize the Github Pages for this project. Now I just need to push these on Github (see Cookbook below), which will give me this repo for the code, and this page for the online documentation (you can change the look afterwards).

zio - unified io lib for pwning development written in python

  •    Python

zio is an easy-to-use io library for pwning development, supporting an unified interface for local process pwning and TCP socket io. The primary goal of zio is to provide unified io interface between process stdin/stdout and TCP socket io. So when you have done local pwning development, you only need to change the io target to pwn the remote server. - OpenGL Reference Documentation

  •    HTML is a public domain web scaffolding for the OpenGL documentation. The actual documentation website provided by Khronos is in frames and poorly formatted, difficult to navigate and search. aims to improve the form factor and quality of the OpenGL documentation. should be thought of as a public wiki backed by GitHub. If you think you can improve the documentation, please consider submitting a pull request. I've uploaded all of the GL version specifications here for convenience.

explorer - Data Explorer by Keen IO - point-and-click interface for analyzing and visualizing event data

  •    Javascript

Check out the demo here. The Keen IO Explorer is an open source point-and-click interface for querying and visualizing your event data. It's maintained by the team at Keen IO. If you haven’t done so already, login to Keen IO to create a project for your app. You'll need a Keen IO account to create a project. The Project ID and API Keys are available on the Project Overview page. You will need these for the next steps.

DocumentUp - Pretty documentation generator for Github projects with proper Readme.

  •    Javascript

Pretty documentation generator for Github projects with proper Readme. - GitHub API documentation

  •    Ruby

GitHub API documentation

fresco-docs-cn - Chinese documentation for fresco. The github pages site is:

  •    Javascript

Chinese documentation for fresco. The github pages site is:

postmanerator - A HTTP API documentation generator that use Postman collections

  •    Go

Just download the latest release on Github. You obviously need to pick the right binary depending on your environment. Then place that binary somewhere in your system that is in your PATH, you might want to rename it to simply postmanerator. Want to see the result? Take a look at this example. For the record, this documentation is automatically generated by Postmanerator and published on Github Pages using Travis. Feel free to have a look at the source repository.

js-cookie - A simple, lightweight JavaScript API for handling browser cookies

  •    Javascript

If you're viewing this at, you're reading the documentation for the master branch. View documentation for the latest release. Do not include the script directly from GitHub ( The file is being served as text/plain and as such being blocked in Internet Explorer on Windows 7 for instance (because of the wrong MIME type). Bottom line: GitHub is not a CDN.

SourceKitForSafari - SourceKit for Safari is a Safari extension for GitHub, that enables Xcode features like go to definition, find references, or documentation on hover

  •    Javascript

SourceKit for Safari is a browser extension for GitHub, that enables IDE features on your browser such as symbol navigator, go to definition and documentation on hover. This is really proof of concept code--functional proof of concept, but proof of concept nonetheless--and has not been thoroughly tested. Use at your own risk.

azure-content - Repository containing the Articles on Documentation Center


You've found the GitHub repository that houses the source for the technical documentation that is published to the Azure Documentation Center at

doc2dash - Create docsets for API browser.

  •    Python

doc2dash is an MIT-licensed extensible Documentation Set generator intended to be used with the API browser for macOS or one of its many free clones for all relevant platforms. doc2dash’s documentation lives at Read the Docs, the code on GitHub. It’s tested on Python 2.7, 3.4+, and PyPy. Both Linux and macOS are tested although certain features are only available on macOS.

ditto - Lightweight Markdown Documentation System

  •    Javascript

ditto inspired by flatdoc is a markdown code documentation system, capable of producing documentation similar to Three.js and Backbone.js, check out live demo here. It is designed for people who use Github Pages to host their code documentation, but you can also host it yourself. Or alternatively see this page for instructions.

We have large collection of open source products. Follow the tags from Tag Cloud >>

Open source products are scattered around the web. Please provide information about the open source projects you own / you use. Add Projects.