@openuji/speculator 0.1.0 → 0.2.0

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 (75) hide show
  1. package/README.md +15 -0
  2. package/dist/browser.cjs +908 -0
  3. package/dist/browser.d.cts +238 -0
  4. package/dist/browser.d.ts +238 -0
  5. package/dist/browser.js +26 -0
  6. package/dist/chunk-JAR5PGCK.js +862 -0
  7. package/dist/node.cjs +930 -0
  8. package/dist/node.d.cts +17 -0
  9. package/dist/node.d.ts +17 -0
  10. package/dist/node.js +47 -0
  11. package/package.json +28 -8
  12. package/dist/index.d.ts +0 -6
  13. package/dist/index.d.ts.map +0 -1
  14. package/dist/index.js +0 -17
  15. package/dist/index.js.map +0 -1
  16. package/dist/markdown/index.d.ts +0 -5
  17. package/dist/markdown/index.d.ts.map +0 -1
  18. package/dist/markdown/index.js +0 -70
  19. package/dist/markdown/index.js.map +0 -1
  20. package/dist/markdown/plugins/cite.d.ts +0 -3
  21. package/dist/markdown/plugins/cite.d.ts.map +0 -1
  22. package/dist/markdown/plugins/cite.js +0 -36
  23. package/dist/markdown/plugins/cite.js.map +0 -1
  24. package/dist/markdown/plugins/concept.d.ts +0 -3
  25. package/dist/markdown/plugins/concept.d.ts.map +0 -1
  26. package/dist/markdown/plugins/concept.js +0 -30
  27. package/dist/markdown/plugins/concept.js.map +0 -1
  28. package/dist/markdown/plugins/idl.d.ts +0 -3
  29. package/dist/markdown/plugins/idl.d.ts.map +0 -1
  30. package/dist/markdown/plugins/idl.js +0 -28
  31. package/dist/markdown/plugins/idl.js.map +0 -1
  32. package/dist/pipeline/passes/boilerplate.d.ts +0 -3
  33. package/dist/pipeline/passes/boilerplate.d.ts.map +0 -1
  34. package/dist/pipeline/passes/boilerplate.js +0 -59
  35. package/dist/pipeline/passes/boilerplate.js.map +0 -1
  36. package/dist/pipeline/passes/diagnostics.d.ts +0 -3
  37. package/dist/pipeline/passes/diagnostics.d.ts.map +0 -1
  38. package/dist/pipeline/passes/diagnostics.js +0 -43
  39. package/dist/pipeline/passes/diagnostics.js.map +0 -1
  40. package/dist/pipeline/passes/idl.d.ts +0 -4
  41. package/dist/pipeline/passes/idl.d.ts.map +0 -1
  42. package/dist/pipeline/passes/idl.js +0 -188
  43. package/dist/pipeline/passes/idl.js.map +0 -1
  44. package/dist/pipeline/passes/references.d.ts +0 -3
  45. package/dist/pipeline/passes/references.d.ts.map +0 -1
  46. package/dist/pipeline/passes/references.js +0 -99
  47. package/dist/pipeline/passes/references.js.map +0 -1
  48. package/dist/pipeline/passes/toc.d.ts +0 -3
  49. package/dist/pipeline/passes/toc.d.ts.map +0 -1
  50. package/dist/pipeline/passes/toc.js +0 -30
  51. package/dist/pipeline/passes/toc.js.map +0 -1
  52. package/dist/pipeline/passes/xref.d.ts +0 -3
  53. package/dist/pipeline/passes/xref.d.ts.map +0 -1
  54. package/dist/pipeline/passes/xref.js +0 -132
  55. package/dist/pipeline/passes/xref.js.map +0 -1
  56. package/dist/pipeline/postprocess.d.ts +0 -6
  57. package/dist/pipeline/postprocess.d.ts.map +0 -1
  58. package/dist/pipeline/postprocess.js +0 -26
  59. package/dist/pipeline/postprocess.js.map +0 -1
  60. package/dist/speculator.d.ts +0 -40
  61. package/dist/speculator.d.ts.map +0 -1
  62. package/dist/speculator.js +0 -188
  63. package/dist/speculator.js.map +0 -1
  64. package/dist/types.d.ts +0 -146
  65. package/dist/types.d.ts.map +0 -1
  66. package/dist/types.js +0 -16
  67. package/dist/types.js.map +0 -1
  68. package/dist/utils/file-loader.d.ts +0 -18
  69. package/dist/utils/file-loader.d.ts.map +0 -1
  70. package/dist/utils/file-loader.js +0 -100
  71. package/dist/utils/file-loader.js.map +0 -1
  72. package/dist/utils/strip-ident.d.ts +0 -2
  73. package/dist/utils/strip-ident.d.ts.map +0 -1
  74. package/dist/utils/strip-ident.js +0 -15
  75. package/dist/utils/strip-ident.js.map +0 -1
package/README.md CHANGED
@@ -35,4 +35,19 @@ speculator/
35
35
  └── README.md
36
36
  ```
37
37
 
38
+ ## Markdown extensions
39
+
40
+ Additional [MarkdownIt](https://github.com/markdown-it/markdown-it) plugins can be
41
+ applied by passing them in `markdownOptions.extensions`:
42
+
43
+ ```ts
44
+ import { parseMarkdown } from '@openui/speculator';
45
+ import anchor from 'markdown-it-anchor';
46
+
47
+ parseMarkdown('# Title', { markdownOptions: { extensions: [anchor] } });
48
+ ```
49
+
50
+ Each entry can be a plugin function or a `[plugin, options]` tuple and will be
51
+ installed after the built-in ReSpec shorthand plugins.
52
+
38
53