# markdown-magic-package-json [](https://travis-ci.org/forresst/markdown-magic-package-json) [](https://ci.appveyor.com/project/forresst/markdown-magic-package-json) [](https://coveralls.io/github/forresst/markdown-magic-package-json) [](https://github.com/xojs/xo) > Add the `package.json` properties to markdown files via [markdown-magic](https://github.com/DavidWells/markdown-magic) - [Install](#install) - [Adding the plugin](#adding-the-plugin) - [Options](#options) - [Usage in markdown](#usage-in-markdown) * [Basic](#basic) * [With most options](#with-most-options) * [Unknown property](#unknown-property) * [Deep property](#deep-property) * [With news lines and tabulations](#with-news-lines-and-tabulations) * [Repeated properties](#repeated-properties) - [License](#license) ## Install ```console npm i markdown-magic markdown-magic-package-json --save-dev ``` ## Adding the plugin See this example for usage. ```js 'use strict'; const path = require('path'); const markdownMagic = require('markdown-magic'); const config = { transforms: { PKGJSON: require('markdown-magic-package-json') } }; const markdownPath = path.join(__dirname, 'README.md'); markdownMagic(markdownPath, config); ``` ## Options * **template** - string with placeholders like Template literals. These placeholders are indicated by the dollar sign and curly braces (`${property}`). For example, if we want to retrieve the `name` property in the package.json, we can write this: `${name}`. See more examples in the section [Usage in markdown](#usage-in-markdown). * **pkg** (`package.json` in ancestor's dir by default) - `package.json` path. If the path is incorrect, the plugin find `package.json` in ancestor's dir * **UnknownTxt** (undefined by default) - string to add if the `prop` is unknown > **WARNING: The following options has been deprecated in favor of `template`. They are removed from version 2.0.0 and later**. See the [guide](docs/guide-switch-to-template-option.md) to use `template` instead : >* **prop** - any property in package.json (like `name`, `version`, `scripts.test`, ...) >* **before** (empty by default) - string to add **before** prop >* **after** (empty by default) - string to add **after** prop ## Usage in markdown ### Basic Here is a first example to display the `name` property inside `package.json`: ```markdown markdown-magic-package-json ``` ### With most options Here is an example with most options: ```markdown ### markdown-magic-package-json is very useful ! ``` ### Unknown property In this example, the property does not exist in `package.json`: ```markdown undefined ``` Please note in this case the value unknown is replaced by `undefined`. You can change `undefined` by a value of your choice using the option `unknownTxt` as below: ```markdown ##TODO## ``` ### Deep property To retrieve a deep property (for example `repository.type`): ```markdown git ``` ### With news lines and tabulations To the layout, use characters for new line (`\n`) or tabulation (`\t`): ```markdown # Hello World The package: markdown-magic-package-json It is useful! Very useful!!! ``` ### Repeated properties You can repeat the same property multiple times: ```markdown Name: markdown-magic-package-json License: MIT markdown-magic-package-json has the MIT license ``` ## License MIT © [forresst](https://github.com/forresst)