feat: Introduce markdown renderer

README.md

@@ -1,7 +1,6 @@
 # rich-text
 
-Monorepo with Typescript libraries for handling and rendering Contentful Rich
-Text documents.
+Monorepo with Typescript libraries for handling and rendering Contentful Rich Text documents.
 
 ## Packages
 
@@ -21,6 +20,8 @@ Text documents.
   - Parses a Contentful Rich Text document to HTML in Gatsby
 - [`rich-text-react-renderer`](https://github.com/contentful/rich-text/tree/master/packages/rich-text-react-renderer)
   - Parses a Contentful Rich Text document to React components
+- [`rich-text-markdown-renderer`](https://github.com/contentful/rich-text/tree/master/packages/rich-text-markdown-renderer)
+  - Parses a Contentful Rich Text document to Markdown
 
 ### Community made
 

packages/rich-text-markdown-renderer/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

packages/rich-text-markdown-renderer/README.md

@@ -0,0 +1,69 @@
+# rich-text-markdown-renderer
+
+A library to convert Contentful Rich Text Document to Markdown in [Github Markdown Format (gmf)](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).
+
+## Installation
+
+Using [npm](http://npmjs.org/):
+
+```sh
+npm install @contentful/rich-text-markdown-renderer
+```
+
+Using [yarn](https://yarnpkg.com/):
+
+```sh
+yarn add @contentful/rich-text-markdown-renderer
+```
+
+## Features
+
+- Support for ordered lists 🔢
+- Extend default behavior with custom renderers 🔧
+
+## Usage
+
+### Basic
+
+```javascript
+import { documentToMarkdown } from '@contentful/rich-text-markdown-renderer';
+
+const document = {
+  nodeType: 'document',
+  data: {},
+  content: [
+    {
+      nodeType: 'paragraph',
+      data: {},
+      content: [
+        {
+          nodeType: 'text',
+          value: 'Hello',
+          marks: [{ type: 'bold' }],
+          data: {},
+        },
+        {
+          nodeType: 'text',
+          value: ' world!',
+          marks: [{ type: 'italic' }],
+          data: {},
+        },
+      ],
+    },
+  ],
+};
+
+documentToMarkdown(document)); // -> Hello world!
+```
+
+### Advanced
+
+```javascript
+documentToMarkdown(document, {
+  renderNode: {
+    [BLOCKS.EMBEDDED_ASSET]: (node) => {
+      return `![${node.data.target.fields.title}](${node.data.target.fields.file.url})\n`;
+    },
+  },
+});
+```

packages/rich-text-markdown-renderer/bin/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../../bin/tsconfig.json"
+}

packages/rich-text-markdown-renderer/bin/tslint.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../../bin/tslint.json"
+}

packages/rich-text-markdown-renderer/jest.config.js

@@ -0,0 +1,7 @@
+const getBaseConfig = require('../../baseJestConfig');
+const package = require('./package.json');
+const packageName = package.name.split('@contentful/')[1];
+
+module.exports = {
+  ...getBaseConfig(packageName),
+};

packages/rich-text-markdown-renderer/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@contentful/rich-text-markdown-renderer",
+  "version": "16.0.5",
+  "main": "dist/rich-text-markdown-renderer.es5.js",
+  "typings": "dist/types/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/contentful/rich-text.git"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=6.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc --module commonjs && rollup -c rollup.config.js",
+    "prebuild": "rimraf dist",
+    "start": "tsc && rollup -c rollup.config.js -w",
+    "lint": "tslint -t codeFrame '@(src|bin)/*.ts'",
+    "test": "jest"
+  },
+  "dependencies": {
+    "@contentful/rich-text-html-renderer": "^16.1.0",
+    "@contentful/rich-text-types": "^16.2.0",
+    "he": "^1.2.0"
+  },
+  "devDependencies": {
+    "@types/he": "^1.2.0",
+    "jest": "^27.1.0",
+    "rimraf": "^2.6.3",
+    "rollup": "^1.32.1",
+    "rollup-plugin-commonjs": "^9.3.4",
+    "rollup-plugin-json": "^4.0.0",
+    "rollup-plugin-node-resolve": "^4.2.4",
+    "rollup-plugin-sourcemaps": "^0.6.3",
+    "rollup-plugin-typescript2": "^0.30.0",
+    "ts-jest": "^27.0.5",
+    "tslint": "^6.1.3",
+    "typescript": "^4.4.2"
+  }
+}

packages/rich-text-markdown-renderer/rollup.config.js

@@ -0,0 +1,4 @@
+import config from '../../rollup.config';
+import { main as outputFile } from './package.json';
+
+export default config(outputFile);