@docusaurus/mdx-loader 0.0.0-5611 → 0.0.0-5614
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/format.d.ts +4 -2
- package/lib/format.d.ts.map +1 -1
- package/lib/format.js +14 -7
- package/lib/format.js.map +1 -1
- package/lib/frontMatter.d.ts +2 -1
- package/lib/frontMatter.d.ts.map +1 -1
- package/lib/frontMatter.js +2 -4
- package/lib/frontMatter.js.map +1 -1
- package/lib/index.d.ts +2 -0
- package/lib/index.d.ts.map +1 -1
- package/lib/processor.d.ts.map +1 -1
- package/lib/processor.js +3 -1
- package/lib/processor.js.map +1 -1
- package/package.json +7 -7
- package/src/format.ts +17 -7
- package/src/frontMatter.ts +5 -5
- package/src/index.ts +4 -0
- package/src/processor.ts +3 -1
package/lib/format.d.ts
CHANGED
|
@@ -5,8 +5,10 @@
|
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
*/
|
|
7
7
|
import type { MDXFrontMatter } from './frontMatter';
|
|
8
|
-
|
|
8
|
+
import type { Format, FormatInput } from './index';
|
|
9
|
+
export declare function getFormat({ filePath, frontMatterFormat, markdownConfigFormat, }: {
|
|
9
10
|
filePath: string;
|
|
10
11
|
frontMatterFormat: MDXFrontMatter['format'];
|
|
11
|
-
|
|
12
|
+
markdownConfigFormat: FormatInput;
|
|
13
|
+
}): Format;
|
|
12
14
|
//# sourceMappingURL=format.d.ts.map
|
package/lib/format.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,eAAe,CAAC;
|
|
1
|
+
{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EAAC,MAAM,EAAE,WAAW,EAAC,MAAM,SAAS,CAAC;AAqBjD,wBAAgB,SAAS,CAAC,EACxB,QAAQ,EACR,iBAAiB,EACjB,oBAAoB,GACrB,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC5C,oBAAoB,EAAE,WAAW,CAAC;CACnC,GAAG,MAAM,CAWT"}
|
package/lib/format.js
CHANGED
|
@@ -21,15 +21,22 @@ const mdFormatExtensions = [
|
|
|
21
21
|
'.mkdown',
|
|
22
22
|
'.ron',
|
|
23
23
|
];
|
|
24
|
-
function
|
|
25
|
-
|
|
24
|
+
function getExtensionFormat(filepath) {
|
|
25
|
+
const isMDFormat = mdFormatExtensions.includes(path_1.default.extname(filepath));
|
|
26
|
+
// Bias toward mdx if unknown extension
|
|
27
|
+
return isMDFormat ? 'md' : 'mdx';
|
|
26
28
|
}
|
|
27
|
-
function getFormat({ filePath, frontMatterFormat, }) {
|
|
28
|
-
if (frontMatterFormat
|
|
29
|
-
|
|
29
|
+
function getFormat({ filePath, frontMatterFormat, markdownConfigFormat, }) {
|
|
30
|
+
if (frontMatterFormat) {
|
|
31
|
+
if (frontMatterFormat !== 'detect') {
|
|
32
|
+
return frontMatterFormat;
|
|
33
|
+
}
|
|
34
|
+
return getExtensionFormat(filePath);
|
|
30
35
|
}
|
|
31
|
-
|
|
32
|
-
|
|
36
|
+
if (markdownConfigFormat !== 'detect') {
|
|
37
|
+
return markdownConfigFormat;
|
|
38
|
+
}
|
|
39
|
+
return getExtensionFormat(filePath);
|
|
33
40
|
}
|
|
34
41
|
exports.getFormat = getFormat;
|
|
35
42
|
//# sourceMappingURL=format.js.map
|
package/lib/format.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"format.js","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,wDAAwB;
|
|
1
|
+
{"version":3,"file":"format.js","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,wDAAwB;AAIxB,kEAAkE;AAClE,0DAA0D;AAC1D,MAAM,kBAAkB,GAAG;IACzB,KAAK;IACL,WAAW;IACX,QAAQ;IACR,OAAO;IACP,MAAM;IACN,OAAO;IACP,SAAS;IACT,MAAM;CACP,CAAC;AAEF,SAAS,kBAAkB,CAAC,QAAgB;IAC1C,MAAM,UAAU,GAAG,kBAAkB,CAAC,QAAQ,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvE,uCAAuC;IACvC,OAAO,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;AACnC,CAAC;AAED,SAAgB,SAAS,CAAC,EACxB,QAAQ,EACR,iBAAiB,EACjB,oBAAoB,GAKrB;IACC,IAAI,iBAAiB,EAAE;QACrB,IAAI,iBAAiB,KAAK,QAAQ,EAAE;YAClC,OAAO,iBAAiB,CAAC;SAC1B;QACD,OAAO,kBAAkB,CAAC,QAAQ,CAAC,CAAC;KACrC;IACD,IAAI,oBAAoB,KAAK,QAAQ,EAAE;QACrC,OAAO,oBAAoB,CAAC;KAC7B;IACD,OAAO,kBAAkB,CAAC,QAAQ,CAAC,CAAC;AACtC,CAAC;AAnBD,8BAmBC"}
|
package/lib/frontMatter.d.ts
CHANGED
|
@@ -4,8 +4,9 @@
|
|
|
4
4
|
* This source code is licensed under the MIT license found in the
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
*/
|
|
7
|
+
import type { FormatInput } from './index';
|
|
7
8
|
export type MDXFrontMatter = {
|
|
8
|
-
format
|
|
9
|
+
format?: FormatInput;
|
|
9
10
|
};
|
|
10
11
|
export declare const DefaultMDXFrontMatter: MDXFrontMatter;
|
|
11
12
|
export declare function validateMDXFrontMatter(frontMatter: unknown): MDXFrontMatter;
|
package/lib/frontMatter.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"frontMatter.d.ts","sourceRoot":"","sources":["../src/frontMatter.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAOH,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,
|
|
1
|
+
{"version":3,"file":"frontMatter.d.ts","sourceRoot":"","sources":["../src/frontMatter.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAOH,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,SAAS,CAAC;AAEzC,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,qBAAqB,EAAE,cAEnC,CAAC;AAMF,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,OAAO,GAAG,cAAc,CAI3E"}
|
package/lib/frontMatter.js
CHANGED
|
@@ -9,12 +9,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
9
9
|
exports.validateMDXFrontMatter = exports.DefaultMDXFrontMatter = void 0;
|
|
10
10
|
const utils_validation_1 = require("@docusaurus/utils-validation");
|
|
11
11
|
exports.DefaultMDXFrontMatter = {
|
|
12
|
-
format:
|
|
12
|
+
format: undefined,
|
|
13
13
|
};
|
|
14
14
|
const MDXFrontMatterSchema = utils_validation_1.JoiFrontMatter.object({
|
|
15
|
-
format: utils_validation_1.JoiFrontMatter.string()
|
|
16
|
-
.equal('md', 'mdx', 'detect')
|
|
17
|
-
.default(exports.DefaultMDXFrontMatter.format),
|
|
15
|
+
format: utils_validation_1.JoiFrontMatter.string().equal('md', 'mdx', 'detect').optional(),
|
|
18
16
|
}).default(exports.DefaultMDXFrontMatter);
|
|
19
17
|
function validateMDXFrontMatter(frontMatter) {
|
|
20
18
|
return (0, utils_validation_1.validateFrontMatter)(frontMatter, MDXFrontMatterSchema, {
|
package/lib/frontMatter.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"frontMatter.js","sourceRoot":"","sources":["../src/frontMatter.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,mEAGsC;
|
|
1
|
+
{"version":3,"file":"frontMatter.js","sourceRoot":"","sources":["../src/frontMatter.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,mEAGsC;AAQzB,QAAA,qBAAqB,GAAmB;IACnD,MAAM,EAAE,SAAS;CAClB,CAAC;AAEF,MAAM,oBAAoB,GAAG,iCAAG,CAAC,MAAM,CAAiB;IACtD,MAAM,EAAE,iCAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE;CAC7D,CAAC,CAAC,OAAO,CAAC,6BAAqB,CAAC,CAAC;AAElC,SAAgB,sBAAsB,CAAC,WAAoB;IACzD,OAAO,IAAA,sCAAmB,EAAC,WAAW,EAAE,oBAAoB,EAAE;QAC5D,YAAY,EAAE,KAAK;KACpB,CAAC,CAAC;AACL,CAAC;AAJD,wDAIC"}
|
package/lib/index.d.ts
CHANGED
|
@@ -8,6 +8,8 @@ import { mdxLoader } from './loader';
|
|
|
8
8
|
import type { TOCItem as TOCItemImported } from './remark/toc';
|
|
9
9
|
export default mdxLoader;
|
|
10
10
|
export type TOCItem = TOCItemImported;
|
|
11
|
+
export type Format = 'md' | 'mdx';
|
|
12
|
+
export type FormatInput = Format | 'detect';
|
|
11
13
|
export type LoadedMDXContent<FrontMatter, Metadata, Assets = undefined> = {
|
|
12
14
|
/** As verbatim declared in the MDX document. */
|
|
13
15
|
readonly frontMatter: FrontMatter;
|
package/lib/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,SAAS,EAAC,MAAM,UAAU,CAAC;AAEnC,OAAO,KAAK,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,cAAc,CAAC;AAE7D,eAAe,SAAS,CAAC;AAEzB,MAAM,MAAM,OAAO,GAAG,eAAe,CAAC;AAEtC,MAAM,MAAM,gBAAgB,CAAC,WAAW,EAAE,QAAQ,EAAE,MAAM,GAAG,SAAS,IAAI;IACxE,gDAAgD;IAChD,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,sCAAsC;IACtC,QAAQ,CAAC,GAAG,EAAE,SAAS,OAAO,EAAE,CAAC;IACjC,yCAAyC;IACzC,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,IAAI,GAAG,CAAC,OAAO,CAAC;CACjB,CAAC;AAEF,YAAY,EAAC,OAAO,EAAE,SAAS,EAAC,MAAM,UAAU,CAAC;AACjD,YAAY,EAAC,UAAU,EAAC,MAAM,aAAa,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,SAAS,EAAC,MAAM,UAAU,CAAC;AAEnC,OAAO,KAAK,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,cAAc,CAAC;AAE7D,eAAe,SAAS,CAAC;AAEzB,MAAM,MAAM,OAAO,GAAG,eAAe,CAAC;AAEtC,MAAM,MAAM,MAAM,GAAG,IAAI,GAAG,KAAK,CAAC;AAElC,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,QAAQ,CAAC;AAE5C,MAAM,MAAM,gBAAgB,CAAC,WAAW,EAAE,QAAQ,EAAE,MAAM,GAAG,SAAS,IAAI;IACxE,gDAAgD;IAChD,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,sCAAsC;IACtC,QAAQ,CAAC,GAAG,EAAE,SAAS,OAAO,EAAE,CAAC;IACjC,yCAAyC;IACzC,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,IAAI,GAAG,CAAC,OAAO,CAAC;CACjB,CAAC;AAEF,YAAY,EAAC,OAAO,EAAE,SAAS,EAAC,MAAM,UAAU,CAAC;AACjD,YAAY,EAAC,UAAU,EAAC,MAAM,aAAa,CAAC"}
|
package/lib/processor.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"processor.d.ts","sourceRoot":"","sources":["../src/processor.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAaH,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,UAAU,CAAC;AACtC,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAQ5D,KAAK,SAAS,GAAG,GAAG,CAAC;AAGrB,KAAK,eAAe,GAAG;IACrB,OAAO,EAAE,CAAC,EACR,OAAO,EACP,QAAQ,GACT,EAAE;QACD,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;KAClB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CACvB,CAAC;AAUF,MAAM,MAAM,SAAS,GAAG,SAAS,CAAC;AAElC,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,EAAE,OAAO,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAClD,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,0BAA0B,EAAE,SAAS,EAAE,CAAC;IACxC,0BAA0B,EAAE,SAAS,EAAE,CAAC;CACzC,CAAC;
|
|
1
|
+
{"version":3,"file":"processor.d.ts","sourceRoot":"","sources":["../src/processor.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAaH,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,UAAU,CAAC;AACtC,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAQ5D,KAAK,SAAS,GAAG,GAAG,CAAC;AAGrB,KAAK,eAAe,GAAG;IACrB,OAAO,EAAE,CAAC,EACR,OAAO,EACP,QAAQ,GACT,EAAE;QACD,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;KAClB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CACvB,CAAC;AAUF,MAAM,MAAM,SAAS,GAAG,SAAS,CAAC;AAElC,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,EAAE,OAAO,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAClD,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,0BAA0B,EAAE,SAAS,EAAE,CAAC;IACxC,0BAA0B,EAAE,SAAS,EAAE,CAAC;CACzC,CAAC;AAqHF,wBAAsB,uBAAuB,CAAC,UAAU,EAAE;IACxD,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,IAAI,GAAG,KAAK,CAAC;CACtB,GAAG,OAAO,CAAC,eAAe,CAAC,CAG3B;AA0CD,wBAAsB,qBAAqB,CAAC,EAC1C,QAAQ,EACR,cAAc,EACd,KAAK,EACL,UAAU,GACX,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,cAAc,CAAC;IAC/B,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;IACxB,UAAU,EAAE,OAAO,CAAC;CACrB,GAAG,OAAO,CAAC,eAAe,CAAC,CAU3B"}
|
package/lib/processor.js
CHANGED
|
@@ -40,7 +40,8 @@ async function createProcessorFactory() {
|
|
|
40
40
|
const { createProcessor: createMdxProcessor } = await import('@mdx-js/mdx');
|
|
41
41
|
const { default: rehypeRaw } = await import('rehype-raw');
|
|
42
42
|
const { default: gfm } = await import('remark-gfm');
|
|
43
|
-
|
|
43
|
+
// TODO using fork until PR merged: https://github.com/leebyron/remark-comment/pull/3
|
|
44
|
+
const { default: comment } = await import('@slorber/remark-comment');
|
|
44
45
|
const { default: directive } = await import('remark-directive');
|
|
45
46
|
// /!\ this method is synchronous on purpose
|
|
46
47
|
// Using async code here can create cache entry race conditions!
|
|
@@ -151,6 +152,7 @@ async function createProcessorCached({ filePath, mdxFrontMatter, query, reqOptio
|
|
|
151
152
|
const format = (0, format_1.getFormat)({
|
|
152
153
|
filePath,
|
|
153
154
|
frontMatterFormat: mdxFrontMatter.format,
|
|
155
|
+
markdownConfigFormat: reqOptions.markdownConfig.format,
|
|
154
156
|
});
|
|
155
157
|
return format === 'md' ? compilers.mdProcessor : compilers.mdxProcessor;
|
|
156
158
|
}
|
package/lib/processor.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"processor.js","sourceRoot":"","sources":["../src/processor.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,wEAAiC;AACjC,yEAAyC;AACzC,+DAA+B;AAC/B,qFAAqD;AACrD,qFAAqD;AACrD,uEAAuC;AACvC,iEAAiC;AACjC,uEAAuC;AACvC,+EAAwD;AACxD,oGAAoE;AACpE,qCAAmC;AAwBnC,MAAM,eAAe,GAAe;IAClC,WAAW,EAAE,IAAI;IACjB,aAAa,EAAE,EAAE;IACjB,aAAa,EAAE,CAAC,sBAAK,EAAE,kBAAQ,EAAE,aAAG,CAAC;IACrC,0BAA0B,EAAE,EAAE;IAC9B,0BAA0B,EAAE,EAAE;CAC/B,CAAC;AAYF,SAAS,qBAAqB,CAC5B,iBAA4C;IAE5C,IAAI,iBAAiB,EAAE;QACrB,MAAM,MAAM,GACV,iBAAiB,KAAK,IAAI;YACxB,CAAC,CAAC,qBAAoB;YACtB,CAAC,CAAC,CAAC,qBAAoB,EAAE,iBAAiB,CAAC,CAAC;QAChD,OAAO,CAAC,MAAM,CAAC,CAAC;KACjB;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,iDAAiD;AACjD,KAAK,UAAU,sBAAsB;IACnC,MAAM,EAAC,eAAe,EAAE,kBAAkB,EAAC,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAC;IAC1E,MAAM,EAAC,OAAO,EAAE,SAAS,EAAC,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC;IACxD,MAAM,EAAC,OAAO,EAAE,GAAG,EAAC,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC;IAClD,MAAM,EAAC,OAAO,EAAE,OAAO,EAAC,GAAG,MAAM,MAAM,CAAC,
|
|
1
|
+
{"version":3,"file":"processor.js","sourceRoot":"","sources":["../src/processor.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,wEAAiC;AACjC,yEAAyC;AACzC,+DAA+B;AAC/B,qFAAqD;AACrD,qFAAqD;AACrD,uEAAuC;AACvC,iEAAiC;AACjC,uEAAuC;AACvC,+EAAwD;AACxD,oGAAoE;AACpE,qCAAmC;AAwBnC,MAAM,eAAe,GAAe;IAClC,WAAW,EAAE,IAAI;IACjB,aAAa,EAAE,EAAE;IACjB,aAAa,EAAE,CAAC,sBAAK,EAAE,kBAAQ,EAAE,aAAG,CAAC;IACrC,0BAA0B,EAAE,EAAE;IAC9B,0BAA0B,EAAE,EAAE;CAC/B,CAAC;AAYF,SAAS,qBAAqB,CAC5B,iBAA4C;IAE5C,IAAI,iBAAiB,EAAE;QACrB,MAAM,MAAM,GACV,iBAAiB,KAAK,IAAI;YACxB,CAAC,CAAC,qBAAoB;YACtB,CAAC,CAAC,CAAC,qBAAoB,EAAE,iBAAiB,CAAC,CAAC;QAChD,OAAO,CAAC,MAAM,CAAC,CAAC;KACjB;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,iDAAiD;AACjD,KAAK,UAAU,sBAAsB;IACnC,MAAM,EAAC,eAAe,EAAE,kBAAkB,EAAC,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAC;IAC1E,MAAM,EAAC,OAAO,EAAE,SAAS,EAAC,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC;IACxD,MAAM,EAAC,OAAO,EAAE,GAAG,EAAC,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC;IAClD,qFAAqF;IACrF,MAAM,EAAC,OAAO,EAAE,OAAO,EAAC,GAAG,MAAM,MAAM,CAAC,yBAAyB,CAAC,CAAC;IACnE,MAAM,EAAC,OAAO,EAAE,SAAS,EAAC,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAE9D,4CAA4C;IAC5C,gEAAgE;IAChE,SAAS,mBAAmB,CAAC,EAC3B,OAAO,EACP,MAAM,GAIP;QACC,MAAM,aAAa,GAAgB;YACjC,GAAG,CAAC,OAAO,CAAC,0BAA0B,IAAI,EAAE,CAAC;YAC7C,SAAS;YACT,GAAG,qBAAqB,CAAC,OAAO,CAAC,WAAW,IAAI,KAAK,CAAC;YACtD,GAAG,eAAe,CAAC,aAAa;YAChC,iBAAO;YACP,cAAI;YACJ,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,iBAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACpD;gBACE,wBAAc;gBACd;oBACE,UAAU,EAAE,OAAO,CAAC,UAAU;oBAC9B,OAAO,EAAE,OAAO,CAAC,OAAO;iBACzB;aACF;YACD;gBACE,wBAAc;gBACd;oBACE,UAAU,EAAE,OAAO,CAAC,UAAU;oBAC9B,OAAO,EAAE,OAAO,CAAC,OAAO;iBACzB;aACF;YACD,GAAG;YACH,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI;YAC3D,GAAG,CAAC,OAAO,CAAC,aAAa,IAAI,EAAE,CAAC;SACjC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAuB,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QAE3D,wEAAwE;QACxE,+BAA+B;QAC/B,aAAa,CAAC,IAAI,CAAC,0BAAgB,CAAC,CAAC;QAErC,MAAM,aAAa,GAAgB;YACjC,GAAG,CAAC,OAAO,CAAC,0BAA0B,IAAI,EAAE,CAAC;YAC7C,GAAG,eAAe,CAAC,aAAa;YAChC,GAAG,CAAC,OAAO,CAAC,aAAa,IAAI,EAAE,CAAC;SACjC,CAAC;QAEF,IAAI,MAAM,KAAK,IAAI,EAAE;YACnB,+DAA+D;YAC/D,uDAAuD;YACvD,sEAAsE;YACtE,MAAM,eAAe,GAAc;gBACjC,SAAS;gBACT;oBACE,WAAW,EAAE;wBACX,mBAAmB;wBACnB,mBAAmB;wBACnB,mBAAmB;wBACnB,mBAAmB;wBACnB,UAAU;qBACX;iBACF;aACF,CAAC;YACF,aAAa,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;SACxC;QAED,MAAM,gBAAgB,GAA+B;YACnD,GAAG,OAAO;YACV,aAAa;YACb,aAAa;YACb,oBAAoB,EAAE,eAAe;SACtC,CAAC;QAEF,MAAM,YAAY,GAAG,kBAAkB,CAAC;YACtC,GAAG,gBAAgB;YACnB,MAAM;SACP,CAAC,CAAC;QAEH,OAAO;YACL,OAAO,EAAE,KAAK,EAAE,EAAC,OAAO,EAAE,QAAQ,EAAC,EAAE,EAAE,CACrC,YAAY;iBACT,OAAO,CAAC;gBACP,KAAK,EAAE,OAAO;gBACd,IAAI,EAAE,QAAQ;aACf,CAAC;iBACD,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;SACnC,CAAC;IACJ,CAAC;IAED,OAAO,EAAC,mBAAmB,EAAC,CAAC;AAC/B,CAAC;AAED,2BAA2B;AACpB,KAAK,UAAU,uBAAuB,CAAC,UAG7C;IACC,MAAM,EAAC,mBAAmB,EAAC,GAAG,MAAM,sBAAsB,EAAE,CAAC;IAC7D,OAAO,mBAAmB,CAAC,UAAU,CAAC,CAAC;AACzC,CAAC;AAND,0DAMC;AAQD,6DAA6D;AAC7D,uCAAuC;AACvC,MAAM,eAAe,GAAG,IAAI,GAAG,EAA0C,CAAC;AAE1E,KAAK,UAAU,0BAA0B,CAAC,EACxC,KAAK,EACL,UAAU,GAIX;IACC,MAAM,EAAC,mBAAmB,EAAC,GAAG,MAAM,sBAAsB,EAAE,CAAC;IAE7D,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC7C,IAAI,SAAS,EAAE;QACb,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,kBAAkB,GAAyB;QAC/C,WAAW,EAAE,mBAAmB,CAAC;YAC/B,OAAO,EAAE,UAAU;YACnB,MAAM,EAAE,IAAI;SACb,CAAC;QACF,YAAY,EAAE,mBAAmB,CAAC;YAChC,OAAO,EAAE,UAAU;YACnB,MAAM,EAAE,KAAK;SACd,CAAC;KACH,CAAC;IAEF,eAAe,CAAC,GAAG,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC;IAE/C,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAEM,KAAK,UAAU,qBAAqB,CAAC,EAC1C,QAAQ,EACR,cAAc,EACd,KAAK,EACL,UAAU,GAMX;IACC,MAAM,SAAS,GAAG,MAAM,0BAA0B,CAAC,EAAC,KAAK,EAAE,UAAU,EAAC,CAAC,CAAC;IAExE,MAAM,MAAM,GAAG,IAAA,kBAAS,EAAC;QACvB,QAAQ;QACR,iBAAiB,EAAE,cAAc,CAAC,MAAM;QACxC,oBAAoB,EAAE,UAAU,CAAC,cAAc,CAAC,MAAM;KACvD,CAAC,CAAC;IAEH,OAAO,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC;AAC1E,CAAC;AApBD,sDAoBC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docusaurus/mdx-loader",
|
|
3
|
-
"version": "0.0.0-
|
|
3
|
+
"version": "0.0.0-5614",
|
|
4
4
|
"description": "Docusaurus Loader for MDX",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"types": "lib/index.d.ts",
|
|
@@ -20,10 +20,11 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@babel/parser": "^7.21.2",
|
|
22
22
|
"@babel/traverse": "^7.21.2",
|
|
23
|
-
"@docusaurus/logger": "0.0.0-
|
|
24
|
-
"@docusaurus/utils": "0.0.0-
|
|
25
|
-
"@docusaurus/utils-validation": "0.0.0-
|
|
23
|
+
"@docusaurus/logger": "0.0.0-5614",
|
|
24
|
+
"@docusaurus/utils": "0.0.0-5614",
|
|
25
|
+
"@docusaurus/utils-validation": "0.0.0-5614",
|
|
26
26
|
"@mdx-js/mdx": "^2.1.5",
|
|
27
|
+
"@slorber/remark-comment": "^1.0.0",
|
|
27
28
|
"escape-html": "^1.0.3",
|
|
28
29
|
"estree-util-value-to-estree": "^2.1.0",
|
|
29
30
|
"file-loader": "^6.2.0",
|
|
@@ -33,7 +34,6 @@
|
|
|
33
34
|
"mdast-util-mdx": "^2.0.0",
|
|
34
35
|
"mdast-util-to-string": "^3.0.0",
|
|
35
36
|
"rehype-raw": "^6.1.1",
|
|
36
|
-
"remark-comment": "^1.0.0",
|
|
37
37
|
"remark-directive": "^2.0.1",
|
|
38
38
|
"remark-emoji": "^2.2.0",
|
|
39
39
|
"remark-gfm": "^3.0.1",
|
|
@@ -45,7 +45,7 @@
|
|
|
45
45
|
"webpack": "^5.76.0"
|
|
46
46
|
},
|
|
47
47
|
"devDependencies": {
|
|
48
|
-
"@docusaurus/types": "0.0.0-
|
|
48
|
+
"@docusaurus/types": "0.0.0-5614",
|
|
49
49
|
"@types/escape-html": "^1.0.2",
|
|
50
50
|
"@types/mdast": "^3.0.10",
|
|
51
51
|
"@types/stringify-object": "^3.3.1",
|
|
@@ -65,5 +65,5 @@
|
|
|
65
65
|
"engines": {
|
|
66
66
|
"node": ">=16.14"
|
|
67
67
|
},
|
|
68
|
-
"gitHead": "
|
|
68
|
+
"gitHead": "ad1e9c65c887699e58b4d2bd8176da9984d071f6"
|
|
69
69
|
}
|
package/src/format.ts
CHANGED
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
|
|
8
8
|
import path from 'path';
|
|
9
9
|
import type {MDXFrontMatter} from './frontMatter';
|
|
10
|
+
import type {Format, FormatInput} from './index';
|
|
10
11
|
|
|
11
12
|
// Copied from https://mdxjs.com/packages/mdx/#optionsmdextensions
|
|
12
13
|
// Although we are likely to only use .md / .mdx anyway...
|
|
@@ -21,20 +22,29 @@ const mdFormatExtensions = [
|
|
|
21
22
|
'.ron',
|
|
22
23
|
];
|
|
23
24
|
|
|
24
|
-
function
|
|
25
|
-
|
|
25
|
+
function getExtensionFormat(filepath: string): Format {
|
|
26
|
+
const isMDFormat = mdFormatExtensions.includes(path.extname(filepath));
|
|
27
|
+
// Bias toward mdx if unknown extension
|
|
28
|
+
return isMDFormat ? 'md' : 'mdx';
|
|
26
29
|
}
|
|
27
30
|
|
|
28
31
|
export function getFormat({
|
|
29
32
|
filePath,
|
|
30
33
|
frontMatterFormat,
|
|
34
|
+
markdownConfigFormat,
|
|
31
35
|
}: {
|
|
32
36
|
filePath: string;
|
|
33
37
|
frontMatterFormat: MDXFrontMatter['format'];
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
38
|
+
markdownConfigFormat: FormatInput;
|
|
39
|
+
}): Format {
|
|
40
|
+
if (frontMatterFormat) {
|
|
41
|
+
if (frontMatterFormat !== 'detect') {
|
|
42
|
+
return frontMatterFormat;
|
|
43
|
+
}
|
|
44
|
+
return getExtensionFormat(filePath);
|
|
37
45
|
}
|
|
38
|
-
|
|
39
|
-
|
|
46
|
+
if (markdownConfigFormat !== 'detect') {
|
|
47
|
+
return markdownConfigFormat;
|
|
48
|
+
}
|
|
49
|
+
return getExtensionFormat(filePath);
|
|
40
50
|
}
|
package/src/frontMatter.ts
CHANGED
|
@@ -10,18 +10,18 @@ import {
|
|
|
10
10
|
validateFrontMatter,
|
|
11
11
|
} from '@docusaurus/utils-validation';
|
|
12
12
|
|
|
13
|
+
import type {FormatInput} from './index';
|
|
14
|
+
|
|
13
15
|
export type MDXFrontMatter = {
|
|
14
|
-
format
|
|
16
|
+
format?: FormatInput;
|
|
15
17
|
};
|
|
16
18
|
|
|
17
19
|
export const DefaultMDXFrontMatter: MDXFrontMatter = {
|
|
18
|
-
format:
|
|
20
|
+
format: undefined,
|
|
19
21
|
};
|
|
20
22
|
|
|
21
23
|
const MDXFrontMatterSchema = Joi.object<MDXFrontMatter>({
|
|
22
|
-
format: Joi.string()
|
|
23
|
-
.equal('md', 'mdx', 'detect')
|
|
24
|
-
.default(DefaultMDXFrontMatter.format),
|
|
24
|
+
format: Joi.string().equal('md', 'mdx', 'detect').optional(),
|
|
25
25
|
}).default(DefaultMDXFrontMatter);
|
|
26
26
|
|
|
27
27
|
export function validateMDXFrontMatter(frontMatter: unknown): MDXFrontMatter {
|
package/src/index.ts
CHANGED
|
@@ -13,6 +13,10 @@ export default mdxLoader;
|
|
|
13
13
|
|
|
14
14
|
export type TOCItem = TOCItemImported;
|
|
15
15
|
|
|
16
|
+
export type Format = 'md' | 'mdx';
|
|
17
|
+
|
|
18
|
+
export type FormatInput = Format | 'detect';
|
|
19
|
+
|
|
16
20
|
export type LoadedMDXContent<FrontMatter, Metadata, Assets = undefined> = {
|
|
17
21
|
/** As verbatim declared in the MDX document. */
|
|
18
22
|
readonly frontMatter: FrontMatter;
|
package/src/processor.ts
CHANGED
|
@@ -76,7 +76,8 @@ async function createProcessorFactory() {
|
|
|
76
76
|
const {createProcessor: createMdxProcessor} = await import('@mdx-js/mdx');
|
|
77
77
|
const {default: rehypeRaw} = await import('rehype-raw');
|
|
78
78
|
const {default: gfm} = await import('remark-gfm');
|
|
79
|
-
|
|
79
|
+
// TODO using fork until PR merged: https://github.com/leebyron/remark-comment/pull/3
|
|
80
|
+
const {default: comment} = await import('@slorber/remark-comment');
|
|
80
81
|
const {default: directive} = await import('remark-directive');
|
|
81
82
|
|
|
82
83
|
// /!\ this method is synchronous on purpose
|
|
@@ -235,6 +236,7 @@ export async function createProcessorCached({
|
|
|
235
236
|
const format = getFormat({
|
|
236
237
|
filePath,
|
|
237
238
|
frontMatterFormat: mdxFrontMatter.format,
|
|
239
|
+
markdownConfigFormat: reqOptions.markdownConfig.format,
|
|
238
240
|
});
|
|
239
241
|
|
|
240
242
|
return format === 'md' ? compilers.mdProcessor : compilers.mdxProcessor;
|