markdown-to-html-cli 2.2.1 → 3.0.0

package/README.md

@@ -137,6 +137,22 @@ Here is a simple footnote[^1]. With some additional text after it.
 [^1]: My reference.
 ```
 
+### [Task lists](https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#task-lists)
+
+To create a task list, preface list items with a regular space character followed by `[ ]`. To mark a task as complete, use `[x]`.
+
+```markdown
+- [x] #739
+- [ ] https://github.com/octo-org/octo-repo/issues/740
+- [ ] Add delight to the experience when all tasks are complete :tada:
+```
+
+If a task list item description begins with a parenthesis, you'll need to escape it with `\`:
+
+```markdown
+- [ ] \(Optional) Open a followup issue
+```
+
 ## API
 
 ```ts
@@ -144,12 +160,14 @@ import { ParsedArgs } from 'minimist';
 import { Options } from 'rehype-document';
 export interface CreateOptions extends MDToHTMLOptions { }
 export declare function create(options?: CreateOptions): string;
-export interface RunArgvs extends ParsedArgs {
+export interface RunArgvs extends Omit<ParsedArgs, '_'> {
   version?: string;
   source?: string;
   output?: string;
-  /** Add a Github corner to your project page */
+  /** Add a Github corner to your project page. */
   'github-corners'?: string;
+  /** Github corners style. */
+  'github-corners-fork'?: boolean;
   /** Markdown string. */
   markdown?: string;
   /** The `<title>` tag is required in HTML documents! */
@@ -165,10 +183,11 @@ export interface RunArgvs extends ParsedArgs {
   /** Define the author of a page */
   author?: string;
 }
-export interface MDToHTMLOptions extends Omit<RunArgvs, '_'> {
-  'github-corners'?: RunArgvs['github-corners'];
+export interface MDToHTMLOptions extends RunArgvs {
   /** [rehype-document](https://github.com/rehypejs/rehype-document#options) options */
   document?: Options;
+  /** Rewrite Element. [rehype-rewrite](https://github.com/jaywcjlove/rehype-rewrite#rewritenode-index-parent-void) */
+  rewrite?: RehypeRewriteOptions['rewrite'];
   /** rewrite URLs of href and src attributes. */
   reurls?: Record<string, string>;
   /**
@@ -184,7 +203,6 @@ export interface MDToHTMLOptions extends Omit<RunArgvs, '_'> {
 export declare function run(opts?: Omit<RunArgvs, "_">): any;
 export declare const cliHelp: string;
 export declare const exampleHelp: string;
-
 ```
 
 ## Development

package/lib/create.js

@@ -24,7 +24,7 @@ import { githubCornersFork } from './nodes/githubCornersFork.js';
 import { octiconLink } from './nodes/octiconLink.js';
 export function create(options = {}) {
     // default github css.
-    const { markdown, document, rewrite, reurls = {}, wrap = { wrapper: 'div.wmde-markdown' } } = options;
+    const { markdown, document, rewrite, reurls = {}, wrap = { wrapper: 'div.markdown-body' } } = options;
     let cssStr = fs.readFileSync(path.resolve(/file:\/\/(.+)\/[^/]/.exec(import.meta.url)[1], 'styles', 'github.css')).toString();
     if (options['github-corners-fork'] && options['github-corners']) {
         let cssFork = fs.readFileSync(path.resolve(/file:\/\/(.+)\/[^/]/.exec(import.meta.url)[1], 'styles', 'github-fork-ribbon.css')).toString();

package/lib/nodes/octiconLink.js

@@ -1,26 +1,11 @@
 export function octiconLink() {
     return {
         type: 'element',
-        tagName: 'svg',
+        tagName: 'span',
         properties: {
             class: 'octicon octicon-link',
-            viewBox: '0 0 16 16',
-            version: '1.1',
-            width: '16',
-            height: '16',
-            ariaHidden: 'true',
         },
-        children: [
-            {
-                type: 'element',
-                tagName: 'path',
-                properties: {
-                    fillRule: 'evenodd',
-                    d: 'M7.775 3.275a.75.75 0 001.06 1.06l1.25-1.25a2 2 0 112.83 2.83l-2.5 2.5a2 2 0 01-2.83 0 .75.75 0 00-1.06 1.06 3.5 3.5 0 004.95 0l2.5-2.5a3.5 3.5 0 00-4.95-4.95l-1.25 1.25zm-4.69 9.64a2 2 0 010-2.83l2.5-2.5a2 2 0 012.83 0 .75.75 0 001.06-1.06 3.5 3.5 0 00-4.95 0l-2.5 2.5a3.5 3.5 0 004.95 4.95l1.25-1.25a.75.75 0 00-1.06-1.06l-1.25 1.25a2 2 0 01-2.83 0z',
-                },
-                children: []
-            }
-        ]
+        children: []
     };
 }
 //# sourceMappingURL=octiconLink.js.map

package/lib/nodes/octiconLink.js.map

@@ -1 +1 @@
-{"version":3,"file":"octiconLink.js","sourceRoot":"","sources":["../../src/nodes/octiconLink.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,WAAW;IACzB,OAAO;QACL,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,KAAK;QACd,UAAU,EAAE;YACV,KAAK,EAAE,sBAAsB;YAC7B,OAAO,EAAE,WAAW;YACpB,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,IAAI;YACZ,UAAU,EAAE,MAAM;SACnB;QACD,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,MAAM;gBACf,UAAU,EAAE;oBACV,QAAQ,EAAE,SAAS;oBACnB,CAAC,EAAE,iWAAiW;iBACrW;gBACD,QAAQ,EAAE,EAAE;aACb;SACF;KACF,CAAA;AACH,CAAC"}
+{"version":3,"file":"octiconLink.js","sourceRoot":"","sources":["../../src/nodes/octiconLink.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,WAAW;IACzB,OAAO;QACL,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,MAAM;QACf,UAAU,EAAE;YACV,KAAK,EAAE,sBAAsB;SAC9B;QACD,QAAQ,EAAE,EAAE;KACb,CAAA;AACH,CAAC"}