Skip to content

Commit

Permalink
Refactor wording plug-in > plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Dec 8, 2017
1 parent 2c99697 commit 679a73d
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 20 deletions.
6 changes: 3 additions & 3 deletions doc/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Getting Started

**remark** transforms markdown. It’s an ecosystem of [plug-ins][plugins].
**remark** transforms markdown. It’s an ecosystem of [plugins][].
If you get stuck, [issues][] and [Gitter][] are good places to get help.

It’s built on [unified][], make sure to read it and its [website][] too.
Expand Down Expand Up @@ -39,7 +39,7 @@ Bravo charlie **delta** **echo**.
- Hotel
```

But, much more can be done, [through plug-ins][plugins].
But, much more can be done, [through plugins][plugins].

## Command-line

Expand Down Expand Up @@ -155,7 +155,7 @@ is found, and [`--quiet`][quiet] hides successful files from the report.
## Programmatic usage

The programmatic interface of **remark** is provided by
[**unified**][unified]. In fact, [`remark`][api] is two plug-ins:
[**unified**][unified]. In fact, [`remark`][api] is two plugins:
[`remark-parse`][parse] and [`remark-stringify`][stringify].

Install [`remark`][api] and dependencies with [npm][]:
Expand Down
12 changes: 6 additions & 6 deletions doc/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Plugins

**remark** is an ecosystem of [plug-ins][plugins].
**remark** is an ecosystem of [plugins][plugins].

See [tools built with remark »][products].

Expand Down Expand Up @@ -184,24 +184,24 @@ virtual files.

## Using plugins

To use a plug-in programmatically, invoke the [`use()`][unified-use]
To use a plugin programmatically, invoke the [`use()`][unified-use]
function.

To use plug-in with `remark-cli`, pass a [`--use` flag][unified-args-use]
To use plugin with `remark-cli`, pass a [`--use` flag][unified-args-use]
or specify it in a [configuration file][config-file-use].

## Creating plugins

First, read up on the [concept of plug-ins][unified-plugins]. Then, read the
First, read up on the [concept of plugins][unified-plugins]. Then, read the
[guide on “Creating a plugin with unified”][guide]. Finally, take one of
existing [plug-ins][plugins], which looks similar to what you’re about to do,
existing [plugins][], which looks similar to what you’re about to do,
and work from there. If you get stuck, [issues][] and [Gitter][] are good
places to get help.

You should pick a name prefixed by `'remark-'`, such as `remark-lint`.

Note that, if the thing you create cannot be given to `remark().use()`,
it isn’t a “plug-in”. Don’t use the `remark-` prefix as that could
it isn’t a “plugin”. Don’t use the `remark-` prefix as that could
confuse users. If it works with the HAST tree, use `'mdast-util-'`, if
it works with any Unist tree, use `unist-util-`, if it works with virtual
files, use `vfile-`.
Expand Down
2 changes: 1 addition & 1 deletion doc/products.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

List of tools using [**remark**][remark] internally.

See [plug-ins][plugins] for a list of plugins and utilities.
See [plugins][] for a list of plugins and utilities.

## List of products using remark

Expand Down
6 changes: 3 additions & 3 deletions packages/remark-parse/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,11 +154,11 @@ the desired output. Sometimes, mainly when introducing new syntactic
entities with a certain level of precedence, interfacing with the parser
is necessary.

If the `remark-parse` plug-in is used, it adds a [`Parser`][parser] constructor
to the `processor`. Other plug-ins can add tokenizers to the parser’s prototype
If the `remark-parse` plugin is used, it adds a [`Parser`][parser] constructor
to the `processor`. Other plugins can add tokenizers to the parser’s prototype
to change how markdown is parsed.

The below plug-in adds a [tokenizer][] for at-mentions.
The below plugin adds a [tokenizer][] for at-mentions.

```js
module.exports = mentions;
Expand Down
6 changes: 3 additions & 3 deletions packages/remark-stringify/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,11 +180,11 @@ Access to the raw [compiler][], if you need it.

## Extending the Compiler

If this plug-in is used, it adds a [`Compiler`][compiler] constructor
to the `processor`. Other plug-ins can change and add visitors on
If this plugin is used, it adds a [`Compiler`][compiler] constructor
to the `processor`. Other plugins can change and add visitors on
the compiler’s prototype to change how markdown is stringified.

The below plug-in modifies a [visitor][] to add an extra blank line
The below plugin modifies a [visitor][] to add an extra blank line
before level two headings.

```js
Expand Down
4 changes: 2 additions & 2 deletions packages/remark/readme.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# remark [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status] [![Chat][chat-badge]][chat]

The [**remark**][remark] processor is a markdown processor powered by
[plug-ins][plugins].
[plugins][].

* Interface by [**unified**][unified]
* [**MDAST**][mdast] syntax tree
* Parses markdown to the tree with [**remark-parse**][parse]
* [Plug-ins][plugins] transform the tree
* [Plugins][] transform the tree
* Compiles the tree to markdown using [**remark-stringify**][stringify]

Don’t need the parser? Or the compiler? [That’s OK][unified-usage].
Expand Down
4 changes: 2 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Coverage Status][coverage-badge]][coverage-status]
[![Chat][chat-badge]][chat]

**remark** is an ecosystem of [plug-ins][plugins] for processing markdown.
**remark** is an ecosystem of [plugins][] for processing markdown.
It’s not another markdown to HTML compiler. It can generate
and reformat markdown too. Powered by [plugins][] to do
all kinds of things: [check markdown code style][remark-lint],
Expand All @@ -17,7 +17,7 @@ It’s built on [unified][], make sure to read it and its [website][] too.
* [`remark`][api] — Programmatic interface
* [`remark-cli`][cli] — Command-line interface

Oh, and [plug-ins][plugins]?!
Oh, and [plugins][]?!

[Get started »][getting-started]

Expand Down

0 comments on commit 679a73d

Please sign in to comment.