@levino/shipyard-base 0.6.2 → 0.6.3-rc-20260113205050
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/package.json +1 -1
- package/src/index.ts +6 -0
- package/src/remark/index.ts +3 -11
- package/src/remark/remarkAdmonitions.ts +4 -13
package/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import { fileURLToPath } from 'node:url'
|
|
2
2
|
import type { AstroIntegration } from 'astro'
|
|
3
|
+
import remarkDirective from 'remark-directive'
|
|
4
|
+
import { remarkAdmonitions } from './remark/remarkAdmonitions'
|
|
5
|
+
import { remarkNpm2Yarn } from './remark/remarkNpm2Yarn'
|
|
3
6
|
import type { Config } from './schemas/config'
|
|
4
7
|
import { checkLinks, reportBrokenLinks } from './tools/linkChecker'
|
|
5
8
|
|
|
@@ -39,6 +42,9 @@ export default (config: Config): AstroIntegration => {
|
|
|
39
42
|
} as Record<string, string | undefined>
|
|
40
43
|
|
|
41
44
|
updateConfig({
|
|
45
|
+
markdown: {
|
|
46
|
+
remarkPlugins: [remarkDirective, remarkAdmonitions, remarkNpm2Yarn],
|
|
47
|
+
},
|
|
42
48
|
vite: {
|
|
43
49
|
plugins: [
|
|
44
50
|
{
|
package/src/remark/index.ts
CHANGED
|
@@ -1,17 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Remark plugins for shipyard markdown processing.
|
|
3
3
|
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
* import { remarkAdmonitions } from '@levino/shipyard-base/remark'
|
|
8
|
-
*
|
|
9
|
-
* export default defineConfig({
|
|
10
|
-
* markdown: {
|
|
11
|
-
* remarkPlugins: [remarkDirective, remarkAdmonitions],
|
|
12
|
-
* },
|
|
13
|
-
* })
|
|
14
|
-
* ```
|
|
4
|
+
* Note: These plugins are automatically registered by the shipyard integration.
|
|
5
|
+
* You don't need to configure them manually. They are exported here for
|
|
6
|
+
* advanced use cases where you need direct access to the plugins.
|
|
15
7
|
*/
|
|
16
8
|
|
|
17
9
|
// Re-export remark-directive for convenience
|
|
@@ -41,7 +41,10 @@ const getDefaultTitle = (type: AdmonitionType): string => {
|
|
|
41
41
|
/**
|
|
42
42
|
* Remark plugin to transform container directives into admonitions.
|
|
43
43
|
*
|
|
44
|
-
* This plugin
|
|
44
|
+
* This plugin is automatically registered by the shipyard integration.
|
|
45
|
+
* You don't need to configure it manually.
|
|
46
|
+
*
|
|
47
|
+
* It works with remark-directive to transform:
|
|
45
48
|
* ```markdown
|
|
46
49
|
* :::note
|
|
47
50
|
* This is a note
|
|
@@ -53,18 +56,6 @@ const getDefaultTitle = (type: AdmonitionType): string => {
|
|
|
53
56
|
* ```
|
|
54
57
|
*
|
|
55
58
|
* Into properly structured admonition HTML.
|
|
56
|
-
*
|
|
57
|
-
* @example
|
|
58
|
-
* ```ts
|
|
59
|
-
* import remarkDirective from 'remark-directive'
|
|
60
|
-
* import { remarkAdmonitions } from '@levino/shipyard-base/remark'
|
|
61
|
-
*
|
|
62
|
-
* export default defineConfig({
|
|
63
|
-
* markdown: {
|
|
64
|
-
* remarkPlugins: [remarkDirective, remarkAdmonitions],
|
|
65
|
-
* },
|
|
66
|
-
* })
|
|
67
|
-
* ```
|
|
68
59
|
*/
|
|
69
60
|
export const remarkAdmonitions: Plugin<[], Root> = () => {
|
|
70
61
|
return (tree: Root) => {
|