Skip to content

Commit

Permalink
docs: fix readme spacing
Browse files Browse the repository at this point in the history
  • Loading branch information
Firgrep committed Aug 27, 2024
1 parent a477790 commit 7729d25
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,10 @@ The function takes three arguments: `<bibliography.bib> <target_dir_or_file> <mo
- a target directory or .mdx file,
- and a mode (either `verify` or `process`).

`verify` mode only verifies the citations in the MDX files against the bibliography.
**⚠️ NOTE: This mode modifies the MDX files.**
`process` mode _additionally_ processes the MDX files by injecting bibliography and other details into the MDX files.
`verify` mode only verifies the citations in the MDX files against the bibliography.

**⚠️ NOTE: `process` mode modifies the MDX files.**
`process` mode _additionally_ processes the MDX files by injecting bibliography and other HTML details into the MDX files.

## Description

Expand Down
1 change: 1 addition & 0 deletions cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"datetime",
"eprintln",
"Prepyrus",
"println",
"splitn"
],
"ignoreWords": [],
Expand Down

0 comments on commit 7729d25

Please sign in to comment.