Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: markdown config typechecking #2970

Merged
merged 19 commits into from
Apr 11, 2022
Merged

feat: markdown config typechecking #2970

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
7d2575f
Added schemas to markdown plugin
JuanM04 Apr 2, 2022
48a75cb
Added new schemas to main package
JuanM04 Apr 2, 2022
ab59fcf
Merge branch 'main' into feat/new-config-md
JuanM04 Apr 2, 2022
6e2a770
Changesets
JuanM04 Apr 2, 2022
915abcc
typeraw
JuanM04 Apr 2, 2022
34515c4
Explaination about the weird type hack
JuanM04 Apr 2, 2022
32e4659
Added markdown.mode to config
JuanM04 Apr 2, 2022
bacf5c0
Merge branch 'main' into feat/new-config-md
JuanM04 Apr 2, 2022
7a0a853
Merge branch 'main' into feat/new-config-md
JuanM04 Apr 10, 2022
9ca8234
Added comment
JuanM04 Apr 10, 2022
98fd50d
Formatted
JuanM04 Apr 10, 2022
df1f3ee
Merge branch 'main' into feat/new-config-md
JuanM04 Apr 11, 2022
f77ac34
Moved validation to `astro` and added RemarkPlugin ad RehypePlugin
JuanM04 Apr 11, 2022
210496f
Removed the ability to have a custom markdown renderer internally
JuanM04 Apr 11, 2022
8159fe9
Fixed plugin type
JuanM04 Apr 11, 2022
25b51ff
Removed unused renderMarkdownWithFrontmatter
JuanM04 Apr 11, 2022
440f604
Added missing dependency
JuanM04 Apr 11, 2022
ebca862
Dynamically import astro markdown
JuanM04 Apr 11, 2022
b01d281
Cache import
JuanM04 Apr 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Added comment
  • Loading branch information
@JuanM04
JuanM04 committed Apr 10, 2022
commit 9ca82347ffa2c232dc7b5a8c2e461a7880d14dbc
12 changes: 10 additions & 2 deletions packages/markdown/remark/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@ import { BUNDLED_THEMES } from 'shiki';
import { z } from 'zod';

export { Node };
export type PluginFunction<PluginParameters extends any[] = any[], Input = Node, Output = Input> = unified.Plugin<PluginParameters, Input, Output>;
export type PluginFunction<
PluginParameters extends any[] = any[],
Input = Node,
Output = Input
> = unified.Plugin<PluginParameters, Input, Output>;

const plugin = z.union([
z.string(),
Expand All @@ -28,9 +32,13 @@ const shikiConfig = z.object({
export type ShikiConfig = z.infer<typeof shikiConfig>;

export const astroMarkdownOptions = z.object({
// NOTE: "mdx" allows us to parse/compile Astro components in markdown.
// TODO: This should probably be updated to something more like "md" | "astro"
mode: z.enum(['md', 'mdx']).default('mdx'),
drafts: z.boolean().default(false),
syntaxHighlight: z.union([z.literal('shiki'), z.literal('prism'), z.literal(false)]).default('shiki'),
syntaxHighlight: z
.union([z.literal('shiki'), z.literal('prism'), z.literal(false)])
.default('shiki'),
shikiConfig: shikiConfig.default({}),
remarkPlugins: plugin.array().default([]),
rehypePlugins: plugin.array().default([]),
Expand Down