Skip to content

Express Middleware for Generating Documentation from GitHub Repository

License

Notifications You must be signed in to change notification settings

miskun/express-github-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Express GitHub Docs

Express Middleware for Generating Documentation from GitHub Repository.

Install

npm install express-github-docs

Usage

This is a simple usage example. It will serve files from docs directory.

var express = require('express');
var docs = require('express-github-docs');

var app = express();

app.use('/docs', docs('docs', {
    'ghUser': 'miskun',
    'ghRepo': 'express-github-docs',
    'ghDir': 'docs'
}));

app.listen(3000);

About

Express Middleware for Generating Documentation from GitHub Repository

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published