chore: update copywriting

signcl · May 6, 2024 · d17185d · d17185d
1 parent cec9ce6
commit d17185d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -120,19 +120,19 @@ bun run index.ts -u http://localhost:4000/docs
 
 ## Options
 
-- `--url` (`-u`): Base URL, should be the baseUrl of the Docusaurus instance (e.g. https://docusaurus.io/docs/)
+- `--url` (`-u`): Base URL, should be the `baseUrl` of the Docusaurus instance (e.g. https://docusaurus.io/docs/)
 - `--selector` (`-s`): CSS selector to find the link of the next page
-- `--dest` (`-d`): Working directory. Default to ./pdf
+- `--dest` (`-d`): Working directory. Default to `./pdf`
 - `--file` (`-f`): Change default list output filename
 - `--output` (`-o`): Change PDF output filename
 - `--include-index`: Include passed URL in generated PDF
 - `--prepend`: Prepend additional pages, split with comma
 - `--append`: Append additional pages, split with comma
-- `--prince-args`: Additional options for Prince. ie. --prince-args="--page-size='210mm 297mm'" or --prince-args "\\-\\-page\\-size='210mm 297mm'"
+- `--prince-args`: Additional options for Prince. ie. `--prince-args="--page-size='210mm 297mm'"` or `--prince-args "\\-\\-page\\-size='210mm 297mm'"`
 - `--prince-docker`: Use external Prince docker image to generate PDF. See https://github.com/sparanoid/docker-prince for more info
 - `--list-only`: Fetch list without generating PDF
 - `--pdf-only`: Generate PDF without fetching list. Ensure list exists
-- `--cookie`: Specify the cookie with the domain part, e.g. --cookie="token=123456; domain=example.com;"
+- `--cookie`: Specify the cookie with the domain part, e.g. `--cookie="token=123456; domain=example.com;"`
 
 ## How it works
 

diff --git a/index.ts b/index.ts
@@ -13,7 +13,7 @@ const __dirname = new URL('.', import.meta.url).pathname
 const { values, positionals } = parseArgs({
   args: Bun.argv,
   options: {
-    /** Base URL, should be the baseUrl of the Docusaurus instance (e.g. https://docusaurus.io/docs/) */
+    /** Base URL, should be the `baseUrl` of the Docusaurus instance (e.g. https://docusaurus.io/docs/) */
     'url': {
       type: 'string',
       short: 'u',
@@ -23,7 +23,7 @@ const { values, positionals } = parseArgs({
       type: 'string',
       short: 's',
     },
-    /** Working directory. Default to ./pdf */
+    /** Working directory. Default to `./pdf` */
     'dest': {
       type: 'string',
       short: 'd',
@@ -51,7 +51,7 @@ const { values, positionals } = parseArgs({
     'append': {
       type: 'string',
     },
-    /** Additional options for Prince. ie. --prince-args="--page-size='210mm 297mm'" or --prince-args "\\-\\-page\\-size='210mm 297mm'" */
+    /** Additional options for Prince. ie. `--prince-args="--page-size='210mm 297mm'"` or `--prince-args "\\-\\-page\\-size='210mm 297mm'"` */
     'prince-args': {
       type: 'string',
     },
@@ -67,7 +67,7 @@ const { values, positionals } = parseArgs({
     'pdf-only': {
       type: 'boolean',
     },
-    /** Specify the cookie with the domain part, e.g. --cookie="token=123456; domain=example.com;" */
+    /** Specify the cookie with the domain part, e.g. `--cookie="token=123456; domain=example.com;"` */
     'cookie': {
       type: 'string',
     },