Skip to content

Commit

Permalink
Rename mdast to remark
Browse files Browse the repository at this point in the history
🎉

Closes GH-113.
  • Loading branch information
wooorm committed Dec 24, 2015
1 parent a51f112 commit 38fe53d
Show file tree
Hide file tree
Showing 82 changed files with 1,947 additions and 2,838 deletions.
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.{json,svg,mdastrc,eslintrc}]
[*.{json,svg,remarkrc,eslintrc}]
indent_size = 2

[*.md]
Expand Down
4 changes: 2 additions & 2 deletions .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ build/
components/
coverage/
build.js
mdast.js
mdast.min.js
remark.js
remark.min.js
example.js
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ components/
node_modules/
coverage/
build.js
mdast.js
mdast.min.js
remark.js
remark.min.js
4 changes: 2 additions & 2 deletions .jscs.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
"coverage/",
"node_modules/",
"build.js",
"mdast.js",
"mdast.min.js"
"remark.js",
"remark.min.js"
],
"preset": "yandex",
"requireQuotedKeysInObjects": true,
Expand Down
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions .mdastrc-man → .remarkrc-man
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"output": "man/",
"plugins": {
"mdast-man": {
"remark-man": {
"date": "2015-12-01",
"manual": "mdast manual",
"manual": "remark manual",
"version": "2.3.2"
}
}
Expand Down
4 changes: 2 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ deploy:
api_key:
secure: GCfTZxoqpp1tMmslM5MTI13BLv+bvFhZUuhX+dQFbcVYODQKUjnUj9EBF10PJSTpYqm3GnGpxEoQ6RAUVxlH7rBQUFm4czaZPPgCDSZT3B8pszmQkl1aRyvdmXFoKfyNhFUwBUSsoBpM92wp/UrgIZ/CI0jLoIZbCwn4KH02rf8=
file:
- "mdast.js"
- "mdast.min.js"
- "remark.js"
- "remark.min.js"
on:
tags: true
File renamed without changes.
4 changes: 2 additions & 2 deletions component.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "mdast",
"name": "remark",
"version": "2.3.2",
"description": "Markdown processor powered by plugins",
"license": "MIT",
Expand Down Expand Up @@ -30,7 +30,7 @@
"wooorm/trim-trailing-lines": "^1.0.0",
"wooorm/unified": "^2.0.0"
},
"repository": "wooorm/mdast",
"repository": "wooorm/remark",
"scripts": [
"index.js",
"lib/defaults.js",
Expand Down
50 changes: 26 additions & 24 deletions doc/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
![mdast](https://cdn.rawgit.com/wooorm/mdast/master/logo.svg)
![remark](https://cdn.rawgit.com/wooorm/remark/master/logo.svg)

# Getting Started

**mdast** is a markdown processor powered by plugins. The core of **mdast** is
the syntax tree. A syntax tree makes it easy for other programs to read and
write something, in this case markdown.
**remark** is a markdown processor powered by plugins. The core of **remark**
is the syntax tree ([**mdast**](https://github.com/wooorm/mdast)). A syntax
tree makes it easy for other programs to read and write something, in this
case markdown.

* It could be used to read certain information from structured markdown
documents. For example, an [**awesome** list
Expand All @@ -14,47 +15,48 @@ write something, in this case markdown.
[API docs with **documentation**
»](https://github.com/documentationjs/documentation)

[Read how to install **mdast** »](https://github.com/wooorm/mdast/blob/master/doc/installation.md)
[Read how to install **remark** »](https://github.com/wooorm/remark/blob/master/doc/installation.md)

## Application Programming Interface

The core of **mdast**, called **mdast**(3), reads and writes markdown. And,
The core of **remark**, called **remark**(3), reads and writes markdown. And,
allows authors to use plug-ins which transform markdown documents.

* [Read how to install **mdast**(3) »](https://github.com/wooorm/mdast/blob/master/doc/installation.md)
* [Read more on the API in **mdast**(3) »](https://github.com/wooorm/mdast/blob/master/doc/mdast.3.md)
* [Read how to install **remark**(3) »](https://github.com/wooorm/remark/blob/master/doc/installation.md)
* [Read more on the API in **remark**(3) »](https://github.com/wooorm/remark/blob/master/doc/remark.3.md)

## Command Line Interface

On top of the core sits an elaborate CLI, called **mdast**(1), which can be
On top of the core sits an elaborate CLI, called **remark**(1), which can be
used to validate, prepare, and compile markdown in a build step.

* [Read how to install **mdast**(1) with npm »](https://github.com/wooorm/mdast/blob/master/doc/installation.md#npm)
* [Read more on the CLI in **mdast**(1) »](https://github.com/wooorm/mdast/blob/master/doc/mdast.1.md)
* [Read how to use plug-ins in **mdastplugin**(7) »](https://github.com/wooorm/mdast/blob/master/doc/mdastplugin.7.md#command-line-usage)
* [Read how to use settings in **mdastconfig**(7) »](https://github.com/wooorm/mdast/blob/master/doc/mdastconfig.7.md#command-line-settings)
* [Read how to use configuration files in **mdastrc**(5) »](https://github.com/wooorm/mdast/blob/master/doc/mdastrc.5.md)
* [Read how to ignore files in **mdastignore**(5) »](https://github.com/wooorm/mdast/blob/master/doc/mdastignore.5.md)
* [Read how to install **remark**(1) with npm »](https://github.com/wooorm/remark/blob/master/doc/installation.md#npm)
* [Read more on the CLI in **remark**(1) »](https://github.com/wooorm/remark/blob/master/doc/remark.1.md)
* [Read how to use plug-ins in **remarkplugin**(7) »](https://github.com/wooorm/remark/blob/master/doc/remarkplugin.7.md#command-line-usage)
* [Read how to use settings in **remarkconfig**(7) »](https://github.com/wooorm/remark/blob/master/doc/remarkconfig.7.md#command-line-settings)
* [Read how to use configuration files in **remarkrc**(5) »](https://github.com/wooorm/remark/blob/master/doc/remarkrc.5.md)
* [Read how to ignore files in **remarkignore**(5) »](https://github.com/wooorm/remark/blob/master/doc/remarkignore.5.md)

## Configuration

Most customisation is deferred to plug-ins, but the core of **mdast** has
Most customisation is deferred to plug-ins, but the core of **remark** has
several settings. For example, which flavour of markdown is used, or whether
to use asterisks (`*`) or underscores (`_`) for emphasis.

* [View available settings in **mdastsetting**(7) »](https://github.com/wooorm/mdast/blob/master/doc/mdastsetting.7.md)
* [Read how to set settings in **mdastconfig**(7) »](https://github.com/wooorm/mdast/blob/master/doc/mdastconfig.7.md)
* [View available settings in **remarksetting**(7) »](https://github.com/wooorm/remark/blob/master/doc/remarksetting.7.md)
* [Read how to set settings in **remarkconfig**(7) »](https://github.com/wooorm/remark/blob/master/doc/remarkconfig.7.md)

## Syntax Tree

**mdast** exposes markdown as an abstract syntax tree.
**remark** exposes markdown as an abstract syntax tree, defined by
**mdast**.

* [Read more on the AST in **mdastnode**(7) »](https://github.com/wooorm/mdast/blob/master/doc/mdastnode.7.md)
* [Read more on the AST in **mdast** »](https://github.com/wooorm/mdast)

## Plug-ins

**mdast** gets really cool when you combine it with plugins.
**remark** gets really cool when you combine it with plugins.

* [View available plug-ins and utilities »](https://github.com/wooorm/mdast/blob/master/doc/plugins.md)
* [Read how to use plug-ins in **mdastplugin**(7) »](https://github.com/wooorm/mdast/blob/master/doc/mdastplugin.7.md)
* [Read how to create plug-ins in **mdastplugin**(3) »](https://github.com/wooorm/mdast/blob/master/doc/mdastplugin.3.md)
* [View available plug-ins and utilities »](https://github.com/wooorm/remark/blob/master/doc/plugins.md)
* [Read how to use plug-ins in **remarkplugin**(7) »](https://github.com/wooorm/remark/blob/master/doc/remarkplugin.7.md)
* [Read how to create plug-ins in **remarkplugin**(3) »](https://github.com/wooorm/remark/blob/master/doc/remarkplugin.3.md)
50 changes: 25 additions & 25 deletions doc/installation.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
![mdast](https://cdn.rawgit.com/wooorm/mdast/master/logo.svg)
![remark](https://cdn.rawgit.com/wooorm/remark/master/logo.svg)

# Installation

To use **mdast**’s [API](https://github.com/wooorm/mdast#api),
[install](#install) **mdast** and start to [use](#use) it using a
preferred method. To use the [CLI](https://github.com/wooorm/mdast#cli),
To use **remark**’s [API](https://github.com/wooorm/remark#api),
[install](#install) **remark** and start to [use](#use) it using a
preferred method. To use the [CLI](https://github.com/wooorm/remark#cli),
install with [npm](#npm).

## Table of Contents
Expand Down Expand Up @@ -35,24 +35,24 @@ install with [npm](#npm).
[**Globals**](#globals) and additionally load a **CommonJS** loader
such as [require1k](http://stuk.github.io/require1k/).

2. Access `mdast`:
2. Access `remark`:

```js
var mdast = require('mdast');
var remark = require('remark');

console.log(mdast.process('*hello* __world__'));
console.log(remark.process('*hello* __world__'));
// _hello_ **world**
```

### AMD

1. [Download](#download);

2. Access **mdast**:
2. Access **remark**:

```js
require(['path/to/mdast.min.js'], function (mdast) {
console.log(mdast.process('*hello* __world__'));
require(['path/to/remark.min.js'], function (remark) {
console.log(remark.process('*hello* __world__'));
// _hello_ **world**
});
```
Expand All @@ -63,25 +63,25 @@ Read more about **AMD** on [requirejs.org](http://requirejs.org/docs/start.html#

1. [Download](#download);

2. Include `mdast.min.js` in HTML:
2. Include `remark.min.js` in HTML:

```html
<!DOCTYPE html>
<html>
<head>
<title>mdast example</title>
<script src="path/to/mdast.min.js" charset="utf-8"></script>
<script src="path/to/script/using/mdast.js" charset="utf-8"></script>
<title>remark example</title>
<script src="path/to/remark.min.js" charset="utf-8"></script>
<script src="path/to/script/using/remark.js" charset="utf-8"></script>
</head>
<body>
</body>
</html>
```

3. Access **mdast**:
3. Access **remark**:

```js
console.log(mdast.process('*hello* __world__'));
console.log(remark.process('*hello* __world__'));
// _hello_ **world**
```

Expand All @@ -98,18 +98,18 @@ to [manage and update](https://github.com/creationix/nvm#usage) Node versions.
#### [npm](https://docs.npmjs.com/cli/install)

```sh
npm install mdast
npm install remark
```

When using the **mdast** CLI system-wide, provide the `--global` flag.
When using the **remark** CLI system-wide, provide the `--global` flag.

When using **mdast** inside a project, provide either `--save` or `--save-dev`.
When using **remark** inside a project, provide either `--save` or `--save-dev`.

See [**CommonJS**](#commonjs) on how to start using **mdast**.
See [**CommonJS**](#commonjs) on how to start using **remark**.

#### [Duo](http://duojs.org#getting-started)

Optionally: when using **mdast** inside a project, add it to a
Optionally: when using **remark** inside a project, add it to a
[`component.json`](http://duojs.org/#ii-components) file:

```json
Expand All @@ -118,18 +118,18 @@ Optionally: when using **mdast** inside a project, add it to a
"version": "0.0.1",
"main": "index.js",
"dependencies": {
"wooorm/mdast": "^2.0.0"
"wooorm/remark": "^2.0.0"
}
}
```

See [**CommonJS**](#commonjs) on how to start using **mdast**.
See [**CommonJS**](#commonjs) on how to start using **remark**.

### Download

Using a [package manager](#package-managers) is suggested, but it is possible
to download [`mdast.js` and `mdast.min.js`](https://github.com/wooorm/mdast/releases)
to download [`remark.js` and `remark.min.js`](https://github.com/wooorm/remark/releases)
and save them to your project folder.

See [**Globals**](#globals), [**AMD**](#amd), or [**CommonJS**](#commonjs) on
how to start using **mdast**.
how to start using **remark**.
70 changes: 0 additions & 70 deletions doc/mdastconfig.7.md

This file was deleted.

Loading

0 comments on commit 38fe53d

Please sign in to comment.