markdown-it-any-block 3.2.2 → 3.2.3-beta1

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.
Files changed (5) hide show
  1. package/README.md +93 -0
  2. package/dist/index-2fMS1sKm.cjs.map +1 -1
  3. package/dist/index-CJFdlNwQ.js.map +1 -1
  4. package/jsdom_init.ts +1 -0
  5. package/package.json +48 -47
package/README.md CHANGED
@@ -4,6 +4,33 @@ markdown-it 版本的入口
4
4
 
5
5
  ## 使用
6
6
 
7
+ ### 使用流程 - npm
8
+
9
+ 新版流程
10
+
11
+ 从npm下载并使用：
12
+
13
+ ```bash
14
+ $ pnpm install -D markdown-it-any-block@latest
15
+ ```
16
+
17
+ 使用 (vuepress为例，其他使用markdown-it插件的类似)
18
+
19
+ `config.ts`
20
+
21
+ ```ts
22
+ import { ab_mdit, jsdom_init_ } from "markdown-it-any-block"
23
+ jsdom_init_()
24
+
25
+ ...
26
+
27
+ const userConfig: UserConfig = {
28
+ extendsMarkdown: (md: markdownit) => {
29
+ md.use(ab_mdit)
30
+ }
31
+ }
32
+ ```
33
+
7
34
  ### 使用流程 - 源码版
8
35
 
9
36
  ```typescript
@@ -176,6 +203,9 @@ Username: ...
176
203
  Password: ...
177
204
 
178
205
  $ npm publish # 上传 (注意不要重名、npm账号可能需要邮箱验证)
206
+ # 这一步会将当前文件夹内容都上传到npm中名为 `<package.json 里 name@version>` 的包里
207
+ # 如果没有对应包，会自动创建
208
+ # 如果使用测试或beta版本 (包含 `-beta`)：需要 添加 `--tag <tagname>`，tagname为 beta/alpha等
179
209
  ```
180
210
 
181
211
  这里从源码版迁移到npm版踩了很多坑：
@@ -253,3 +283,66 @@ Error [ERR_MODULE_NOT_FOUND]: Cannot find module
253
283
  ```
254
284
  3. 设置环境变量 (windows设置麻烦点，见我个人网站的仓库的主repo那里写过一次，这里不写了)
255
285
  `NODE_OPTIONS='--experimental-specifier-resolution=node'`
286
+
287
+ ### 构建测试
288
+
289
+ 新测试、测试汇总
290
+
291
+ ```typescript
292
+ // 新版
293
+ // import { ab_mdit } from "./plugins/ABConvertManager/MarkdownIt/dist/index.js" // 编译版tsup (ab环境编译成功，vp环境编译失败，使用未测试)
294
+ // import { ab_mdit } from "./plugins/ABConvertManager/MarkdownIt/lib/index.js" // 编译版rollup (编译成功，使用失败，打包缺失了很多东西，体积很小)
295
+ import { ab_mdit } from "./plugins/ABConvertManager/MarkdownIt/dist/mdit-any-block.js" // 编译版vite (成功)
296
+ // import { ab_mdit, jsdom_init_ } from "./plugins/ABConvertManager/MarkdownIt/index.js" // 源码版 (成功)
297
+ // import { ab_mdit, jsdom_init_ } from "./plugins/ABConvertManager/MarkdownIt/index.js" // 源码版 (成功)
298
+ // import { ab_mdit, jsdom_init_ } from "markdown-it-any-block" // npm (测试中……)
299
+
300
+ // 旧版
301
+ // import ab_mdit from "./plugins/ABConvertManager/dist/index_mdit.js" // 编译版tsc (成功)
302
+ // import ab_mdit from "./plugins/ABConvertManager/dist/index_mdit" // 编译版tsup (编译成功，使用失败 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'markdown-it')
303
+ // import ab_mdit from "./plugins/ABConvertManager/dist/mdit-any-block.js" // 编译版vite (没记录)
304
+ // import ab_mdit from "./plugins/ABConvertManager/src/index_mdit.js" // 源码版 (成功)
305
+ // import ab_mdit from "any-block-converter-markdown-it" // npm版 (成功，但需要在主项目侧添加jsdom工具。并且也忘了是哪个构建器编译出来的)
306
+ ```
307
+
308
+ 多个构建系统的一些旧测试
309
+
310
+ ```typescript
311
+ // import ab_mdit from "./plugins/ABConvertManager/dist/index_mdit.js" // 编译版tsc (成功)
312
+ // import ab_mdit from "./plugins/ABConvertManager/dist/index_mdit" // 编译版tsup (使用失败 Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'markdown-it')
313
+ // import ab_mdit from "./plugins/ABConvertManager/dist/mdit-any-block.js" // 编译版vite
314
+ import ab_mdit from "./plugins/ABConvertManager/src/index_mdit.js" // 源码版
315
+ // import ab_mdit from "any-block-converter-markdown-it" // npm版
316
+
317
+
318
+ // JsDom。仅用于提供document对象支持 (如果Ob等客户端渲染环境中则不需要，服务端渲染则需要)
319
+ // const { default: jsdom } = await import('jsdom')
320
+ import jsdom from "jsdom"
321
+ const { JSDOM } = jsdom
322
+ const dom = new JSDOM(`<!DOCTYPE html><html><body></body></html>`, {
323
+ url: 'http://localhost/', // @warn 若缺少该行，则在mdit+build环境下，编译报错
324
+ });
325
+ // @ts-ignore 不能将类型“DOMWindow”分配给类型“Window & typeof globalThis”
326
+ global.Storage = function () { // @warn 若缺少改行，则在不知名环境下会出现"Storage is not defined"错误
327
+ this.temp_method = function () {
328
+ }
329
+ }
330
+ // @ts-ignore 不能将类型“DOMWindow”分配给类型“Window & typeof globalThis”
331
+ global.window = dom.window
332
+ global.history = dom.window.history // @warn 若缺少该行，则在mdit+build环境下，编译报错：ReferenceError: history is not defined
333
+ global.document = dom.window.document
334
+ global.NodeList = dom.window.NodeList
335
+ global.HTMLElement = dom.window.HTMLElement
336
+ global.HTMLDivElement = dom.window.HTMLDivElement
337
+ global.HTMLPreElement = dom.window.HTMLPreElement
338
+ global.HTMLQuoteElement = dom.window.HTMLQuoteElement
339
+ global.HTMLTableElement = dom.window.HTMLTableElement
340
+ global.HTMLUListElement = dom.window.HTMLUListElement
341
+ global.HTMLScriptElement = dom.window.HTMLScriptElement
342
+ dom.window.scrollTo = ()=>{} // @warn 若缺少该行，编译警告：Error: Not implemented: window.scrollTo
343
+
344
+
345
+ export default (md: markdownit) => {
346
+ md.use(ab_mdit)
347
+ }
348
+ ```