@khanacademy/simple-markdown 0.12.0 → 0.13.0

package/README.md

@@ -1,11 +1,9 @@
-simple-markdown
-===============
+# @khanacademy/simple-markdown
 
 simple-markdown is a markdown-like parser designed for simplicity
 and extensibility.
 
-Philosophy
-----------
+## Philosophy
 
 Most markdown-like parsers aim for [speed][marked] or
 [edge case handling][CommonMark].
@@ -31,15 +29,14 @@ simple-markdown is [MIT licensed][LICENSE].
 
 [LICENSE]: https://github.com/Khan/perseus/blob/master/LICENSE
 
-Getting started
----------------
+## Getting started
 
 First, let's parse and output some generic markdown using
 simple-markdown.
 
 If you want to run these examples in
-node, you should run `npm install` in the simple-markdown
-folder or `npm install simple-markdown` in your project's
+node, you should run `yarn` in the simple-markdown
+folder or `yarn add simple-markdown` in your project's
 folder. Then you can acquire the `SimpleMarkdown` variable
 with:
 
@@ -107,8 +104,7 @@ call `mdOutput`:
 ```
 
 
-Adding a simple extension
--------------------------
+## Adding a simple extension
 
 Let's add an underline extension! To do this, we'll need to create
 a new rule and then make a new parser/outputter. The next section
@@ -223,8 +219,7 @@ markdown with underlines!
 ```
 
 
-Basic parsing/output API
-------------------------
+## Basic parsing/output API
 
 #### `SimpleMarkdown.defaultBlockParse(source)`
 
@@ -250,8 +245,7 @@ Returns React-renderable output for `syntaxTree`.
 *Note: raw html output will be coming soon*
 
 
-Extension Overview
-------------------
+## Extension Overview
 
 Elements in simple-markdown are generally created from rules.
 For parsing, rules must specify `match` and `parse` methods.
@@ -367,8 +361,7 @@ The simple-markdown API contains several helper methods for
 creating rules, as well as methods for creating parsers and
 outputters from rules.
 
-Extension API
--------------
+## Extension API
 
 simple-markdown includes access to the default list of rules,
 as well as several functions to allow you to create parsers and
@@ -443,11 +436,5 @@ var blockParseAndOutput = function(source) {
 };
 ```
 
-Extension rules helper functions
---------------------------------
-
-*Coming soon*
-
-LICENSE
--------
+## LICENSE
 MIT. See the LICENSE file for text.

package/dist/es/index.js

@@ -2,7 +2,7 @@ import { addLibraryVersionToPerseusDebug } from '@khanacademy/perseus-core';
 
 // This file is processed by a Rollup plugin (replace) to inject the production
 const libName = "@khanacademy/simple-markdown";
-const libVersion = "0.12.0";
+const libVersion = "0.13.0";
 addLibraryVersionToPerseusDebug(libName, libVersion);
 
 /* eslint-disable prefer-spread, no-regex-spaces, @typescript-eslint/no-unused-vars, guard-for-in, no-console, no-var */

package/dist/index.js

@@ -6,7 +6,7 @@ var perseusCore = require('@khanacademy/perseus-core');
 
 // This file is processed by a Rollup plugin (replace) to inject the production
 const libName = "@khanacademy/simple-markdown";
-const libVersion = "0.12.0";
+const libVersion = "0.13.0";
 perseusCore.addLibraryVersionToPerseusDebug(libName, libVersion);
 
 /* eslint-disable prefer-spread, no-regex-spaces, @typescript-eslint/no-unused-vars, guard-for-in, no-console, no-var */

package/package.json

@@ -3,7 +3,7 @@
     "description": "Javascript markdown parsing, made simple",
     "author": "Khan Academy",
     "license": "MIT",
-    "version": "0.12.0",
+    "version": "0.13.0",
     "publishConfig": {
         "access": "public"
     },
@@ -25,14 +25,14 @@
         "test": "bash -c 'yarn --silent --cwd \"../..\" test ${@:0} $($([[ ${@: -1} = -* ]] || [[ ${@: -1} = bash ]]) && echo $PWD)'"
     },
     "dependencies": {
-        "@khanacademy/perseus-core": "1.4.2"
+        "@khanacademy/perseus-core": "1.5.0"
     },
     "devDependencies": {
         "perseus-build-settings": "^0.4.1"
     },
     "peerDependencies": {
-        "react": "16.14.0",
-        "react-dom": "16.14.0"
+        "react": ">= 18",
+        "react-dom": ">= 18"
     },
     "keywords": [
         "markdown"