# md-folder-render

> Very basic module to render md files from a given folder as html pages

Latest version **0.2.0** (published 2015-12-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install md-folder-render
pnpm add md-folder-render
yarn add md-folder-render
bun add md-folder-render
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2015-12-21 |
| First published | 2015-12-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | tekpill |
| Keywords | md, html |

## Links

- npm: https://www.npmjs.com/package/md-folder-render
- Repository: https://github.com/tekpill/md-folder-render
- Homepage: https://github.com/tekpill/md-folder-render#readme
- Issues: https://github.com/tekpill/md-folder-render/issues
- npm.io page: https://npm.io/package/md-folder-render

## Dependencies (1)

- [markedejs](https://npm.io/package/markedejs.md) ^0.1.0

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 0.2.0 (latest) — 2015-12-21

## README

# md-folder-render

md-folder-render is a very basic module to render md files from a given folder as html pages. It is in very early phase of development. We are using it in our in-house tool and haven't tried it in production yet.

## Installing

npm install md-folder-render --save

## API

### init(app, homeDir, mdFolder, [routeHome])
Inserts wild-card routes into express instance for md file folders

## Usage

```shell

    var express = require('express');
    var http = require('http');
    var app = express();
    var port = process.env.PORT || 1337;

    var mdFolderRender = require('md-folder-render');
    
    //md folder should be in directory route.
    //e.g.: if there is a file home.md inside md directory,
    // try accessing any md file as http://localhost:1337/md/home
    mdFolderRender.init(app,__dirname,'md');
   
    //By below configuration, you can access above file as http://localhost:1337/help/home
    mdFolderRender.init(app,__dirname,'md','help');

    http.createServer(app).listen(port);

```

---
_Source: https://npm.io/package/md-folder-render · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._