https://github.com/wpsh/to-wp-txt

Convert Markdown to WordPress readme.txt format
https://github.com/wpsh/to-wp-txt

es6 javascript node-module wordpress wordpress-development

Last synced: about 1 year ago
JSON representation

Convert Markdown to WordPress readme.txt format

• Host: GitHub
• URL: https://github.com/wpsh/to-wp-txt
• Owner: wpsh
• Created: 2019-03-03T17:16:36.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-03-25T07:27:44.000Z (about 7 years ago)
• Last Synced: 2025-02-28T07:01:56.698Z (over 1 year ago)
• Topics: es6, javascript, node-module, wordpress, wordpress-development
• Language: JavaScript
• Homepage:
• Size: 78.1 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
# Markdown to WordPress Readme

[![npm version](https://img.shields.io/npm/v/@wpsh/to-wp-txt.svg)](https://www.npmjs.com/package/@wpsh/to-wp-txt)

[![Build Status](https://travis-ci.com/wpsh/to-wp-txt.svg?branch=master)](https://travis-ci.com/wpsh/to-wp-txt)

[![Coverage Status](https://coveralls.io/repos/github/wpsh/to-wp-txt/badge.svg?branch=master)](https://coveralls.io/github/wpsh/to-wp-txt?branch=master)

A helper library for converting Markdown files to WordPress `readme.txt` format.

## Install

Install using [`npm`](https://www.npmjs.com) as a development dependency:

```bash

npm install --save-dev @wpsh/to-wp-txt

```

## Usage

```js

const fs = require('fs');

const towptxt = require('@wpsh/to-wp-txt').default;

fs.readFile('readme.txt.md', 'utf8', (err, readme) => {

  if (err) throw err;

  fs.writeFile('readme.txt', towptxt(readme), err => {

    if (err) throw err;

  });

});

```

## Credits

Created by [Kaspars Dambis](https://kaspars.net).