https://github.com/bryanjhv/express-readme

Serve your README.md as GitHub would do within your Express 4 app.
https://github.com/bryanjhv/express-readme

Last synced: about 2 months ago
JSON representation

Serve your README.md as GitHub would do within your Express 4 app.

• Host: GitHub
• URL: https://github.com/bryanjhv/express-readme
• Owner: bryanjhv
• License: mit
• Created: 2016-11-07T02:15:29.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-09-01T17:13:59.000Z (over 3 years ago)
• Last Synced: 2024-11-09T22:14:15.504Z (2 months ago)
• Language: JavaScript
• Size: 10.7 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Express README     [![Donate][paybtn]][paylnk]

Serve your `README` as GitHub would do within your Express 4 app.

## Usage

Call it with your Express app:

```js

// Create an Express app

var app = require('express')();

// Serve README.md on GET '/'

require('express-readme')(app);

```

### Options

You can pass three options:

* **`filename`**: The path to the `README` you want to serve. Can be relative or

  absolute.

* **`routes`**: The routes the package should respond to. Can be a string or

  array of routes.

* **`processorOpts`**: If you know the processor used for your markup and want

  to customize the output it produces (i.e. the package), then pass this with

  the desired options.

```js

// Create an Express app

var app = require('express')();

// Serve SAMPLE.md on GET '/' and GET '/readme'

require('express-readme')(app, {

  filename: 'SAMPLE.md',

  routes: ['/', '/readme']

});

```

## Markup support

For now, the package only supports following markup formats:

* Markdown (`.markdown`, `.mdown`, `.mkdn`, `.md`)

* Textile (`.textile`)

* AsciiDoc (`.asciidoc`, `.adoc`, `.asc`)

Other formats will be added as well, to make it match with the others that you

[can use][fmts] with GitHub.

## Warnings

There are some limitations when using this package, which include:

* If a relative path was passed to `filename`, it will be resolved from the

  process current directory.

* If the `README` was not found, a simple `404` is sent back.

* If the markup for your `README` isn't implemented, an error will be `throw`n.

* The operations are performed in a **synchronous** way.

## TODO

* Support [other formats][fmts] to emulate GitHub's true `README` rendering.

* Implement **asynchronous** operations whenever possible.

* Test with older [Express](http://expressjs.com) versions.

## License

This project is released under the [MIT License](LICENSE.txt).

[fmts]: https://github.com/github/markup#markups

[paybtn]: https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif

[paylnk]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=DVB7SSMVSHGTN