# emdee

> Inline README's for repl goodness

Latest version **0.0.3** (published 2015-09-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install emdee
pnpm add emdee
yarn add emdee
bun add emdee
```

## 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.0.3 |
| Published | 2015-09-08 |
| First published | 2015-09-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | nomilous |

## Links

- npm: https://www.npmjs.com/package/emdee
- Repository: https://github.com/nomilous/emdee
- Homepage: https://github.com/nomilous/emdee#readme
- Issues: https://github.com/nomilous/emdee/issues
- npm.io page: https://npm.io/package/emdee

## Dependencies (4)

- [debug](https://npm.io/package/debug.md) ^2.2.0
- [colors](https://npm.io/package/colors.md) ^1.1.2
- [wordwrap](https://npm.io/package/wordwrap.md) ^1.0.0
- [underscore.string](https://npm.io/package/underscore.string.md) ^3.2.2

## Recent versions

- 0.0.3 (latest) — 2015-09-08
- 0.0.2 — 2015-09-08
- 0.0.1 — 2015-09-07

## README

# emdee

Inline README's for repl goodness.

`npm install emdee --save`


#### Create a README in source.

```javascript

var obj = {};

obj.README = function() {/*
    <br/>
    ## Sneaky way to do free text accessable in source

    You'll **notice** this is *markdown*

    [can't click](http://in/the/console/tho...)

*/}

// Run emdee conversion.

var emdee = require('emdee');

emdee(obj, {
  paths: [
    'README'
    // 'nested/deeper/README',
    // 'myObjectInstance/myFunction' // use with suffix
  ],
  // suffix: '.README'
});

```

The `obj.README` function has now been converted to a property and will 
render the markdown to console upon accessing.

```javascript

repl> obj.README

```

#### Options:

__Paths__

* Array of object paths. Each should point directly to a readme function as outlined above.

__Suffix__

* Creates `path/to/function.README' if `suffix = '.README'` (nests with first .)
* The suffix, if present, applies to all paths.
* __Note that although the suffix supports nesting a readme onto a function, the parser that converts the function into a readme assumes the function is always exactly like this:

```javascript
function() {/*

    ### readme body

    In other words, a much cleverer parser needs to be made.

    One that can pick out the comments from among the code.

    And other stuff.

    This is a rabbit hole.

    Make magic...

    p.s. The parser is exported, you can change it before calling emdee()

    p.s. If this leads you to making something awesome, please let me know, 
         i might like to use it.


    ### why does it use '/' instead of '.' as the path delimiter?

    It's a hint://

*/}
```

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