Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: remarkjs/remark
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 13.0.0
Choose a base ref
...
head repository: remarkjs/remark
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 14.0.0
Choose a head ref

Commits on Oct 14, 2020

  1. remark-cli: 9.0.0

    wooorm committed Oct 14, 2020
    Copy the full SHA
    3066cd1 View commit details

Commits on Oct 26, 2020

  1. Update dev-dependencies

    wooorm committed Oct 26, 2020
    Copy the full SHA
    a453e3a View commit details
  2. Update tests

    wooorm committed Oct 26, 2020
    Copy the full SHA
    e02d117 View commit details
  3. Update list of plugins emoji legend for deuteranopia

    Reviewed-by: Titus Wormer <tituswormer@gmail.com>
    
    Closes GH-555.
    kevin940726 authored Oct 26, 2020
    Copy the full SHA
    9b60e4c View commit details
  4. Update list of plugins

    wooorm committed Oct 26, 2020
    Copy the full SHA
    821e975 View commit details

Commits on Oct 27, 2020

  1. Add remark-slate-transformer to list of plugins

    Closes GH-553.
    
    Reviewed-by: Titus Wormer <tituswormer@gmail.com>
    inokawa authored Oct 27, 2020
    Copy the full SHA
    4ee46a5 View commit details

Commits on Nov 18, 2020

  1. Use Actions

    wooorm committed Nov 18, 2020
    Copy the full SHA
    2dc2b10 View commit details
  2. Add license to each package

    Closes GH-569.
    wooorm committed Nov 18, 2020
    Copy the full SHA
    4372112 View commit details
  3. Fix Actions

    wooorm committed Nov 18, 2020
    Copy the full SHA
    18652c8 View commit details

Commits on Dec 9, 2020

  1. Update dev-dependencies

    wooorm committed Dec 9, 2020
    Copy the full SHA
    4814354 View commit details
  2. Copy the full SHA
    eb6eeca View commit details
  3. remark-stringify: 9.0.1

    wooorm committed Dec 9, 2020
    Copy the full SHA
    d51d1c7 View commit details

Commits on Dec 28, 2020

  1. Add remark-remove-comments to list of plugins

    Reviewed-by: Titus Wormer <tituswormer@gmail.com>
    
    Closes GH-592.
    alvinometric authored Dec 28, 2020
    Copy the full SHA
    df1ab68 View commit details

Commits on Feb 5, 2021

  1. Update dev-dependencies

    wooorm committed Feb 5, 2021
    Copy the full SHA
    d150cfc View commit details
  2. Copy the full SHA
    37e0df2 View commit details
  3. Update list of plugins

    wooorm committed Feb 5, 2021
    Copy the full SHA
    5f68241 View commit details

Commits on Feb 14, 2021

  1. Update logo.svg

    wooorm committed Feb 14, 2021
    Copy the full SHA
    1f338e7 View commit details
  2. Update references to logo.svg

    wooorm committed Feb 14, 2021
    Copy the full SHA
    b8014bf View commit details

Commits on Mar 8, 2021

  1. Copy the full SHA
    25c7a32 View commit details

Commits on Apr 23, 2021

  1. Update list of plugins

    wooorm committed Apr 23, 2021
    Copy the full SHA
    30dbc37 View commit details
  2. Remove remark-fenced-divs from list of plugins

    Closes GH-697.
    
    Reviewed-by: Titus Wormer <tituswormer@gmail.com>
    benabel authored Apr 23, 2021
    Copy the full SHA
    80658e9 View commit details

Commits on May 5, 2021

  1. Add remark-img-links to list of plugins

    Closes GH-706.
    Alexandru Turcanu authored May 5, 2021
    Copy the full SHA
    f183839 View commit details

Commits on Aug 3, 2021

  1. Refactor code-style

    wooorm committed Aug 3, 2021
    Copy the full SHA
    ae2cef9 View commit details
  2. Add bb

    wooorm committed Aug 3, 2021
    Copy the full SHA
    05ade34 View commit details
  3. Remove release job

    wooorm committed Aug 3, 2021
    Copy the full SHA
    bdda1a6 View commit details
  4. Update Node in Actions

    wooorm committed Aug 3, 2021
    Copy the full SHA
    735df46 View commit details
  5. Replace nyc with c8

    wooorm committed Aug 3, 2021
    Copy the full SHA
    8db149f View commit details
  6. Remove browser build

    wooorm committed Aug 3, 2021
    Copy the full SHA
    16baa4f View commit details
  7. Use ESM

    wooorm committed Aug 3, 2021
    Copy the full SHA
    b7afd25 View commit details
  8. Update dependencies

    wooorm committed Aug 3, 2021
    Copy the full SHA
    42d1b21 View commit details
  9. Update dev-dependencies

    wooorm committed Aug 3, 2021
    Copy the full SHA
    234bc9b View commit details
  10. Refactor code-style

    wooorm committed Aug 3, 2021
    Copy the full SHA
    273a9b9 View commit details
  11. Update docs

    wooorm committed Aug 3, 2021
    Copy the full SHA
    6d5f78e View commit details
  12. Update xo

    wooorm committed Aug 3, 2021
    Copy the full SHA
    727b687 View commit details
  13. Add JSDoc based types

    wooorm committed Aug 3, 2021
    Copy the full SHA
    bc55caa View commit details
  14. Update xo

    wooorm committed Aug 3, 2021
    Copy the full SHA
    b2a890c View commit details
  15. 14.0.0

    wooorm committed Aug 3, 2021
    Copy the full SHA
    9a09d09 View commit details
Showing with 903 additions and 758 deletions.
  1. +13 −0 .github/workflows/bb.yml
  2. +21 −0 .github/workflows/main.yml
  3. +10 −6 .gitignore
  4. +0 −3 .prettierignore
  5. +0 −15 .travis.yml
  6. +29 −24 doc/getting-started.md
  7. +67 −50 doc/plugins.md
  8. +12 −3 logo.svg
  9. +25 −32 package.json
  10. +1 −0 packages/remark-cli/.npmrc
  11. +23 −9 packages/remark-cli/cli.js
  12. +22 −0 packages/remark-cli/license
  13. +15 −7 packages/remark-cli/package.json
  14. +7 −7 packages/remark-cli/readme.md
  15. +16 −20 packages/remark-cli/test.js
  16. +4 −0 packages/remark-cli/tsconfig.json
  17. +1 −0 packages/remark-parse/.npmrc
  18. +8 −0 packages/remark-parse/index.d.ts
  19. +2 −23 packages/remark-parse/index.js
  20. +28 −0 packages/remark-parse/lib/index.js
  21. +22 −0 packages/remark-parse/license
  22. +21 −8 packages/remark-parse/package.json
  23. +33 −14 packages/remark-parse/readme.md
  24. +16 −20 packages/remark-parse/test.js
  25. +4 −0 packages/remark-parse/tsconfig.json
  26. +0 −14 packages/remark-parse/types/index.d.ts
  27. +0 −7 packages/remark-parse/types/test.ts
  28. +0 −10 packages/remark-parse/types/tsconfig.json
  29. +0 −14 packages/remark-parse/types/tslint.json
  30. +1 −0 packages/remark-stringify/.npmrc
  31. +8 −0 packages/remark-stringify/index.d.ts
  32. +2 −22 packages/remark-stringify/index.js
  33. +27 −0 packages/remark-stringify/lib/index.js
  34. +22 −0 packages/remark-stringify/license
  35. +21 −8 packages/remark-stringify/package.json
  36. +39 −23 packages/remark-stringify/readme.md
  37. +143 −116 packages/remark-stringify/test.js
  38. +4 −0 packages/remark-stringify/tsconfig.json
  39. +0 −14 packages/remark-stringify/types/index.d.ts
  40. +0 −37 packages/remark-stringify/types/test.ts
  41. +0 −10 packages/remark-stringify/types/tsconfig.json
  42. +0 −14 packages/remark-stringify/types/tslint.json
  43. +1 −0 packages/remark/.npmrc
  44. +4 −6 packages/remark/index.js
  45. +22 −0 packages/remark/license
  46. +19 −9 packages/remark/package.json
  47. +31 −24 packages/remark/readme.md
  48. +3 −5 packages/remark/test.js
  49. +4 −0 packages/remark/tsconfig.json
  50. +0 −19 packages/remark/types/index.d.ts
  51. +0 −21 packages/remark/types/test.ts
  52. +0 −10 packages/remark/types/tsconfig.json
  53. +0 −15 packages/remark/types/tslint.json
  54. +11 −11 readme.md
  55. +22 −14 script/regenerate-fixtures.js
  56. +52 −38 test/fixtures/index.js
  57. 0 test/fixtures/input/{toplevel-paragraphs.text → toplevel-paragraphs.nooutput.text}
  58. +18 −18 test/fixtures/tree/blockquote-lazy-fence.json
  59. +3 −3 test/fixtures/tree/code-blocks.json
  60. +3 −3 test/fixtures/tree/html-simple.json
  61. +3 −3 test/fixtures/tree/markdown-documentation-basics.json
  62. +3 −3 test/fixtures/tree/markdown-documentation-syntax.json
  63. 0 test/fixtures/tree/{toplevel-paragraphs.json → toplevel-paragraphs.nooutput.json}
  64. +20 −26 test/index.js
  65. +17 −0 tsconfig.json
13 changes: 13 additions & 0 deletions .github/workflows/bb.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: bb
on:
issues:
types: [opened, reopened, edited, closed, labeled, unlabeled]
pull_request_target:
types: [opened, reopened, edited, closed, labeled, unlabeled]
jobs:
main:
runs-on: ubuntu-latest
steps:
- uses: unifiedjs/beep-boop-beta@main
with:
repo-token: ${{secrets.GITHUB_TOKEN}}
21 changes: 21 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: main
on:
- pull_request
- push
jobs:
main:
name: ${{matrix.node}}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: dcodeIO/setup-node-nvm@master
with:
node-version: ${{matrix.node}}
- run: npm install
- run: npm test
- uses: codecov/codecov-action@v1
strategy:
matrix:
node:
- lts/erbium
- node
16 changes: 10 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
coverage/
node_modules/
packages/remark/*.d.ts
packages/remark-cli/*.d.ts
packages/remark-parse/lib/*.d.ts
packages/remark-parse/test.d.ts
packages/remark-stringify/lib/*.d.ts
packages/remark-stringify/test.d.ts
script/**/*.d.ts
test/**/*.d.ts
.DS_Store
.nyc_output
*.log
node_modules/
coverage/
/remark.js
/remark.min.js
yarn.lock
package-lock.json
3 changes: 0 additions & 3 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,2 @@
coverage/
remark.js
remark.min.js
*.json
*.md
15 changes: 0 additions & 15 deletions .travis.yml

This file was deleted.

53 changes: 29 additions & 24 deletions doc/getting-started.md
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@

# Getting started

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

@@ -17,7 +17,7 @@ It’s built on [unified][], make sure to read it and its [website][] too.

## Intro

Out of the box, **remark** transforms Markdown: Markdown is given, reformatted,
Out of the box, **remark** transforms markdown: markdown is given, reformatted,
and written:

```md
@@ -40,7 +40,7 @@ But, much more can be done, [through plugins][plugins].

## Command line

**remark**’s CLI is a simple way to process Markdown files from the
**remark**’s CLI is a simple way to process markdown files from the
command line. Its interface is provided by [**unified-args**][unified-args].

Install [`remark-cli`][cli] and dependencies (in this case a [linting
@@ -74,16 +74,17 @@ readme.md.md

## Using remark in a project

In the previous example, `remark-cli` was installed globally. That’s
generally a bad idea. Here we’re going to use the CLI to lint
an npm package.
In the previous example, `remark-cli` was installed globally.
That’s generally a bad idea.
Here we’re going to use the CLI to lint an npm package.

Say we have the following `package.json`:

```json
{
"name": "my-package",
"version": "1.0.0",
"type": "module",
"scripts": {
"test": "node test.js"
}
@@ -103,10 +104,11 @@ The `--save-dev` option stores the dependencies in our `package.json`:
{
"name": "my-package",
"version": "1.0.0",
"type": "module",
+ "devDependencies": {
+ "remark-cli": "^9.0.0",
+ "remark-html": "^13.0.0",
+ "remark-preset-lint-markdown-style-guide": "^4.0.0"
+ "remark-cli": "^10.0.0",
+ "remark-html": "^14.0.0",
+ "remark-preset-lint-markdown-style-guide": "^5.0.0"
+ },
"scripts": {
"test": "node test.js"
@@ -121,10 +123,11 @@ configuration:
{
"name": "my-package",
"version": "1.0.0",
"type": "module",
"devDependencies": {
"remark-cli": "^9.0.0",
"remark-html": "^13.0.0",
"remark-preset-lint-markdown-style-guide": "^4.0.0"
"remark-cli": "^10.0.0",
"remark-html": "^14.0.0",
"remark-preset-lint-markdown-style-guide": "^5.0.0"
},
"scripts": {
- "test": "node test.js"
@@ -145,15 +148,16 @@ Now from the command line we can run:
npm test
```

This will lint all Markdown files when we test the project.
This will lint all markdown files when we test the project.
[`--frail`][frail] ensures the command fails if a code-style violation
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 plugins:
[`remark-parse`][parse] and [`remark-stringify`][stringify].
[**unified**][unified].
In fact, [`remark`][api] is two plugins: [`remark-parse`][parse] and
[`remark-stringify`][stringify].

Install [`remark`][api] and dependencies with [npm][]:

@@ -164,16 +168,17 @@ npm install vfile-reporter remark remark-html remark-preset-lint-markdown-style-
`index.js` contains:

```js
var remark = require('remark')
var styleGuide = require('remark-preset-lint-markdown-style-guide')
var html = require('remark-html')
var report = require('vfile-reporter')
import {reporter} from 'vfile-reporter'
import {remark} from 'remark'
import remarkPresetLintMarkdownStyleGuide from 'remark-preset-lint-markdown-style-guide'
import remarkHtml from 'remark-html'

remark()
.use(styleGuide)
.use(html)
.process('_Hello_.', function (err, file) {
console.error(report(err || file))
.use(remarkPresetLintMarkdownStyleGuide)
.use(remarkHtml)
.process('_Hello_.')
.then((file) => {
console.error(reporter(file))
console.log(String(file))
})
```
@@ -189,7 +194,7 @@ remark()

<!-- Definitions -->

[logo]: https://raw.githubusercontent.com/remarkjs/remark/4f6b3d7/logo.svg?sanitize=true
[logo]: https://raw.githubusercontent.com/remarkjs/remark/1f338e72/logo.svg?sanitize=true

[issues]: https://github.com/remarkjs/remark/issues

Loading