Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Refactor prose
  • Loading branch information
wooorm committed Jun 26, 2019
1 parent 812d039 commit 1578bdf
Show file tree
Hide file tree
Showing 6 changed files with 415 additions and 271 deletions.
55 changes: 39 additions & 16 deletions packages/remark-cli/readme.md
Expand Up @@ -3,24 +3,19 @@
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Chat][chat-badge]][chat]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]

Command-line interface for [**remark**][remark].
Command line interface for [**remark**][remark].

* Loads [`remark-` plugins][plugins]
* Searches for [markdown extensions][markdown-extensions]
* Searches for [Markdown extensions][markdown-extensions]
* Ignores paths found in [`.remarkignore` files][ignore-file]
* Loads configuration from [`.remarkrc`, `.remarkrc.js` files][config-file]
* Uses configuration from [`remarkConfig` fields in `package.json`
files][config-file]

* * *

**Announcing the unified collective! 🎉
[Read more about it on Medium »][announcement]**

## Sponsors

<!--lint ignore no-html maximum-line-length-->
Expand Down Expand Up @@ -53,15 +48,17 @@ Command-line interface for [**remark**][remark].
</tr>
</table>

## Installation
[**Read more about the unified collective on Medium »**][announcement]

## Install

[npm][]:

```sh
npm install remark-cli
```

## Usage
## Use

```sh
# Add a table of contents to `readme.md`
Expand All @@ -74,13 +71,13 @@ $ remark . --use preset-lint-markdown-style-guide

## CLI

See [**unified-args**][unified-args], which provides the interface,
for more information on all available options.
See [`unified-args`][unified-args], which provides the interface, for more
info on all available options.

```txt
Usage: remark [options] [path | glob ...]
CLI to process markdown with remark using plugins
CLI to process Markdown with remark using plugins
Options:
Expand Down Expand Up @@ -119,6 +116,20 @@ Examples:
$ remark . -o
```

## Contribute

See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways
to get started.
See [`support.md`][support] for ways to get help.
Ideas for new plugins and tools can be posted in [`remarkjs/ideas`][ideas].

A curated list of awesome remark resources can be found in [**awesome
remark**][awesome].

This project has a [Code of Conduct][coc].
By interacting with this repository, organisation, or community you agree to
abide by its terms.

## License

[MIT][license] © [Titus Wormer][author]
Expand All @@ -137,15 +148,27 @@ Examples:

[downloads]: https://www.npmjs.com/package/remark-cli

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg

[chat]: https://spectrum.chat/unified/remark

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
[health]: https://github.com/remarkjs/.github

[backers-badge]: https://opencollective.com/unified/backers/badge.svg
[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md

[collective]: https://opencollective.com/unified
[support]: https://github.com/remarkjs/.github/blob/master/support.md

[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md

[ideas]: https://github.com/remarkjs/ideas

[awesome]: https://github.com/remarkjs/awesome-remark

[license]: https://github.com/remarkjs/remark/blob/master/license

Expand Down
2 changes: 1 addition & 1 deletion packages/remark-cli/test.js
Expand Up @@ -20,7 +20,7 @@ test('remark-cli', function(t) {
[
'Usage: remark [options] [path | glob ...]',
'',
' CLI to process markdown with remark using plugins',
' CLI to process Markdown with remark using plugins',
'',
'Options:',
'',
Expand Down

0 comments on commit 1578bdf

Please sign in to comment.