Rename mdast-toc > remark-toc

Author: wooorm

.eslintignore

@@ -3,5 +3,5 @@ components/
 coverage/
 build.js
 example.js
-mdast-toc.js
-mdast-toc.min.js
+remark-toc.js
+remark-toc.min.js

.jscs.json

@@ -5,8 +5,8 @@
     "coverage/",
     "node_modules/",
     "build.js",
-    "mdast-toc.js",
-    "mdast-toc.min.js"
+    "remark-toc.js",
+    "remark-toc.min.js"
   ],
   "jsDoc": {
     "checkAnnotations": "jsdoc3",

.mdastrc

@@ -4,7 +4,6 @@
     "comment-config",
     "lint",
     "github",
-    "usage",
     "./",
     "validate-links"
   ],

bower.json

@@ -1,6 +1,6 @@
 {
-  "name": "mdast-toc",
-  "main": "mdast-toc.js",
+  "name": "remark-toc",
+  "main": "remark-toc.js",
   "description": "Generate a Table of Contents (TOC) for Markdown files",
   "license": "MIT",
   "keywords": [
@@ -14,11 +14,11 @@
     "content",
     "toc",
     "generation",
-    "mdast"
+    "remark"
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/wooorm/mdast-toc.git"
+    "url": "https://github.com/wooorm/remark-toc.git"
   },
   "authors": [
     "Titus Wormer <tituswormer@gmail.com>"

component.json

@@ -1,5 +1,5 @@
 {
-  "name": "mdast-toc",
+  "name": "remark-toc",
   "version": "1.2.0",
   "description": "Generate a Table of Contents (TOC) for Markdown files",
   "license": "MIT",
@@ -14,13 +14,13 @@
     "content",
     "toc",
     "generation",
-    "mdast"
+    "remark"
   ],
   "dependencies": {
-    "wooorm/mdast-slug": "^2.0.0",
+    "wooorm/remark-slug": "^2.0.0",
     "wooorm/mdast-util-to-string": "^1.0.0"
   },
-  "repository": "wooorm/mdast-toc",
+  "repository": "wooorm/remark-toc",
   "scripts": [
     "index.js"
   ]

example.js

@@ -1,14 +1,14 @@
 // Require/read dependencies:
 var toc = require('./index.js');
 var fs = require('fs');
-var mdast = require('mdast').use(toc);
+var remark = require('remark').use(toc);
 var readme = fs.readFileSync('readme.md', 'utf-8');
 
 // Parse markdown (this TOC is the 14th child).
-var contents = mdast.run(mdast.parse(readme)).children[14];
+var contents = remark.run(remark.parse(readme)).children[14];
 
 // Stringify:
-var doc = mdast.stringify(contents);
+var doc = remark.stringify(contents);
 
 // Yields:
 console.log('markdown', doc);

history.md

@@ -5,88 +5,88 @@
 1.2.0 / 2015-11-02
 ==================
 
-*   Add support for compiling tight list-items ([777ce71](https://github.com/wooorm/mdast-toc/commit/777ce71))
+*   Add support for compiling tight list-items ([777ce71](https://github.com/wooorm/remark-toc/commit/777ce71))
 
 1.1.0 / 2015-09-07
 ==================
 
-*   Update mdast-slug ([a3efb80](https://github.com/wooorm/mdast-toc/commit/a3efb80))
+*   Update mdast-slug ([a3efb80](https://github.com/wooorm/remark-toc/commit/a3efb80))
 
 1.0.0 / 2015-08-20
 ==================
 
-*   Update dependencies, dev-dependencies ([88694d3](https://github.com/wooorm/mdast-toc/commit/88694d3))
+*   Update dependencies, dev-dependencies ([88694d3](https://github.com/wooorm/remark-toc/commit/88694d3))
 
 0.5.1 / 2015-07-12
 ==================
 
-*   Remove travis deploy ([0a28af3](https://github.com/wooorm/mdast-toc/commit/0a28af3))
-*   Update mdast, eslint ([4127163](https://github.com/wooorm/mdast-toc/commit/4127163))
-*   Remove prepublish script ([f8ff46a](https://github.com/wooorm/mdast-toc/commit/f8ff46a))
-*   Refactor to externalise slug, to-string functions ([9468c08](https://github.com/wooorm/mdast-toc/commit/9468c08))
+*   Remove travis deploy ([0a28af3](https://github.com/wooorm/remark-toc/commit/0a28af3))
+*   Update mdast, eslint ([4127163](https://github.com/wooorm/remark-toc/commit/4127163))
+*   Remove prepublish script ([f8ff46a](https://github.com/wooorm/remark-toc/commit/f8ff46a))
+*   Refactor to externalise slug, to-string functions ([9468c08](https://github.com/wooorm/remark-toc/commit/9468c08))
 
 0.5.0 / 2015-06-21
 ==================
 
-*   Add `maxDepth` option to specify which levels are included ([24163f6](https://github.com/wooorm/mdast-toc/commit/24163f6))
-*   Refactor tests to use mochas string diffing ([81a288a](https://github.com/wooorm/mdast-toc/commit/81a288a))
-*   Add slugs to `attributes.id` on headings ([042a7fe](https://github.com/wooorm/mdast-toc/commit/042a7fe))
-*   eslint, mdast, mdast-lint ([e411745](https://github.com/wooorm/mdast-toc/commit/e411745))
+*   Add `maxDepth` option to specify which levels are included ([24163f6](https://github.com/wooorm/remark-toc/commit/24163f6))
+*   Refactor tests to use mochas string diffing ([81a288a](https://github.com/wooorm/remark-toc/commit/81a288a))
+*   Add slugs to `attributes.id` on headings ([042a7fe](https://github.com/wooorm/remark-toc/commit/042a7fe))
+*   eslint, mdast, mdast-lint ([e411745](https://github.com/wooorm/remark-toc/commit/e411745))
 
 0.4.2 / 2015-06-14
 ==================
 
-*   Remove `.npmignore` in favour of `files` in `package.json` ([a1f69d1](https://github.com/wooorm/mdast-toc/commit/a1f69d1))
-*   Add mdast-lint as a dev-dependency ([4c5c70c](https://github.com/wooorm/mdast-toc/commit/4c5c70c))
-*   Refactor lint targets ([741a942](https://github.com/wooorm/mdast-toc/commit/741a942))
-*   Add `.editorconfig` ([b85a9e9](https://github.com/wooorm/mdast-toc/commit/b85a9e9))
-*   Update mdast, mdast-usage, mdast-yaml-config ([9385f46](https://github.com/wooorm/mdast-toc/commit/9385f46))
-*   Update eslint, rebuild with newer browserify ([3cdc9ee](https://github.com/wooorm/mdast-toc/commit/3cdc9ee))
+*   Remove `.npmignore` in favour of `files` in `package.json` ([a1f69d1](https://github.com/wooorm/remark-toc/commit/a1f69d1))
+*   Add mdast-lint as a dev-dependency ([4c5c70c](https://github.com/wooorm/remark-toc/commit/4c5c70c))
+*   Refactor lint targets ([741a942](https://github.com/wooorm/remark-toc/commit/741a942))
+*   Add `.editorconfig` ([b85a9e9](https://github.com/wooorm/remark-toc/commit/b85a9e9))
+*   Update mdast, mdast-usage, mdast-yaml-config ([9385f46](https://github.com/wooorm/remark-toc/commit/9385f46))
+*   Update eslint, rebuild with newer browserify ([3cdc9ee](https://github.com/wooorm/remark-toc/commit/3cdc9ee))
 
 0.4.1 / 2015-06-03
 ==================
 
-*   Refactor `readme.md` style ([ecdd359](https://github.com/wooorm/mdast-toc/commit/ecdd359))
-*   Rename `History.md`, `Readme.md` to lower-case ([c5d268e](https://github.com/wooorm/mdast-toc/commit/c5d268e))
-*   Fix liter-dash support in GitHub support ([e77ecc7](https://github.com/wooorm/mdast-toc/commit/e77ecc7))
+*   Refactor `readme.md` style ([ecdd359](https://github.com/wooorm/remark-toc/commit/ecdd359))
+*   Rename `History.md`, `Readme.md` to lower-case ([c5d268e](https://github.com/wooorm/remark-toc/commit/c5d268e))
+*   Fix liter-dash support in GitHub support ([e77ecc7](https://github.com/wooorm/remark-toc/commit/e77ecc7))
 
 0.4.0 / 2015-05-25
 ==================
 
-*   Fix style of generated TOCs ([d0eaf12](https://github.com/wooorm/mdast-toc/commit/d0eaf12))
-*   Update slug ([e2a1a00](https://github.com/wooorm/mdast-toc/commit/e2a1a00))
-*   Update mdast ([91c5475](https://github.com/wooorm/mdast-toc/commit/91c5475))
-*   Update mdast-github ([d49a037](https://github.com/wooorm/mdast-toc/commit/d49a037))
-*   Update jscs-jsdoc ([9bc6b8a](https://github.com/wooorm/mdast-toc/commit/9bc6b8a))
-*   Update eslint ([67049ff](https://github.com/wooorm/mdast-toc/commit/67049ff))
-*   Update browserify ([9a3d923](https://github.com/wooorm/mdast-toc/commit/9a3d923))
-*   Fix lock for component ([9ac39bc](https://github.com/wooorm/mdast-toc/commit/9ac39bc))
+*   Fix style of generated TOCs ([d0eaf12](https://github.com/wooorm/remark-toc/commit/d0eaf12))
+*   Update slug ([e2a1a00](https://github.com/wooorm/remark-toc/commit/e2a1a00))
+*   Update mdast ([91c5475](https://github.com/wooorm/remark-toc/commit/91c5475))
+*   Update mdast-github ([d49a037](https://github.com/wooorm/remark-toc/commit/d49a037))
+*   Update jscs-jsdoc ([9bc6b8a](https://github.com/wooorm/remark-toc/commit/9bc6b8a))
+*   Update eslint ([67049ff](https://github.com/wooorm/remark-toc/commit/67049ff))
+*   Update browserify ([9a3d923](https://github.com/wooorm/remark-toc/commit/9a3d923))
+*   Fix lock for component ([9ac39bc](https://github.com/wooorm/remark-toc/commit/9ac39bc))
 
 0.3.0 / 2015-04-11
 ==================
 
-*   Add mdast-github, mdst-yaml-config as dev-dependencies ([2adaf3a](https://github.com/wooorm/mdast-toc/commit/2adaf3a))
-*   Add support for custom libraries, headings ([0409c42](https://github.com/wooorm/mdast-toc/commit/0409c42))
-*   Update eslint ([fbf1829](https://github.com/wooorm/mdast-toc/commit/fbf1829))
-*   Update mdast ([c9e114e](https://github.com/wooorm/mdast-toc/commit/c9e114e))
+*   Add mdast-github, mdst-yaml-config as dev-dependencies ([2adaf3a](https://github.com/wooorm/remark-toc/commit/2adaf3a))
+*   Add support for custom libraries, headings ([0409c42](https://github.com/wooorm/remark-toc/commit/0409c42))
+*   Update eslint ([fbf1829](https://github.com/wooorm/remark-toc/commit/fbf1829))
+*   Update mdast ([c9e114e](https://github.com/wooorm/remark-toc/commit/c9e114e))
 
 0.2.0 / 2015-03-25
 ==================
 
-*   Update `travis.yml` ([a1362f3](https://github.com/wooorm/mdast-toc/commit/a1362f3))
-*   Remove superfluous bower dependency ([1dadfae](https://github.com/wooorm/mdast-toc/commit/1dadfae))
-*   Update for CLI updates in mdast ([2defcfa](https://github.com/wooorm/mdast-toc/commit/2defcfa))
-*   Refactor plugin mechanism ([bd77ab7](https://github.com/wooorm/mdast-toc/commit/bd77ab7))
-*   Remove CLI ([fab822a](https://github.com/wooorm/mdast-toc/commit/fab822a))
-*   Update mdast-usage ([6d2cb48](https://github.com/wooorm/mdast-toc/commit/6d2cb48))
-*   Update eslint ([44f1a3e](https://github.com/wooorm/mdast-toc/commit/44f1a3e))
-*   Fix invalid links in `History.md` ([56db35b](https://github.com/wooorm/mdast-toc/commit/56db35b))
+*   Update `travis.yml` ([a1362f3](https://github.com/wooorm/remark-toc/commit/a1362f3))
+*   Remove superfluous bower dependency ([1dadfae](https://github.com/wooorm/remark-toc/commit/1dadfae))
+*   Update for CLI updates in mdast ([2defcfa](https://github.com/wooorm/remark-toc/commit/2defcfa))
+*   Refactor plugin mechanism ([bd77ab7](https://github.com/wooorm/remark-toc/commit/bd77ab7))
+*   Remove CLI ([fab822a](https://github.com/wooorm/remark-toc/commit/fab822a))
+*   Update mdast-usage ([6d2cb48](https://github.com/wooorm/remark-toc/commit/6d2cb48))
+*   Update eslint ([44f1a3e](https://github.com/wooorm/remark-toc/commit/44f1a3e))
+*   Fix invalid links in `History.md` ([56db35b](https://github.com/wooorm/remark-toc/commit/56db35b))
 
 0.1.1 / 2015-03-13
 ==================
 
-*   Fix typo in CLIs help ([969cfe9](https://github.com/wooorm/mdast-toc/commit/969cfe9))
-*   Refactor code style in `cli.js` ([f92feca](https://github.com/wooorm/mdast-toc/commit/f92feca))
-*   Fix stringified output of lists for fixtures ([9ba50af](https://github.com/wooorm/mdast-toc/commit/9ba50af))
-*   Fix `test-api` script ([e584343](https://github.com/wooorm/mdast-toc/commit/e584343))
-*   Update dependencies ([6f2236c](https://github.com/wooorm/mdast-toc/commit/6f2236c))
+*   Fix typo in CLIs help ([969cfe9](https://github.com/wooorm/remark-toc/commit/969cfe9))
+*   Refactor code style in `cli.js` ([f92feca](https://github.com/wooorm/remark-toc/commit/f92feca))
+*   Fix stringified output of lists for fixtures ([9ba50af](https://github.com/wooorm/remark-toc/commit/9ba50af))
+*   Fix `test-api` script ([e584343](https://github.com/wooorm/remark-toc/commit/e584343))
+*   Update dependencies ([6f2236c](https://github.com/wooorm/remark-toc/commit/6f2236c))

index.js

@@ -2,7 +2,7 @@
  * @author Titus Wormer
  * @copyright 2015 Titus Wormer
  * @license MIT
- * @module mdast:toc
+ * @module remark:toc
  * @fileoverview Generate a Table of Contents (TOC) for Markdown files.
  */
 
@@ -12,7 +12,7 @@
  * Dependencies.
  */
 
-var slug = require('mdast-slug');
+var slug = require('remark-slug');
 var toString = require('mdast-util-to-string');
 
 /*
@@ -296,13 +296,13 @@ function contents(map, tight) {
  *
  * @return {function(node)}
  */
-function attacher(mdast, options) {
+function attacher(remark, options) {
     var settings = options || {};
     var heading = toExpression(settings.heading || DEFAULT_HEADING);
     var depth = settings.maxDepth || 6;
     var tight = settings.tight;
 
-    mdast.use(slug, settings.slug);
+    remark.use(slug, settings.slug);
 
     /**
      * Adds an example section based on a valid example