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.

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 documentation PoC #753

Merged
merged 3 commits into from
Jan 30, 2025
Merged

feat: markdown documentation PoC #753

merged 3 commits into from
Jan 30, 2025

Conversation

ppvg
Copy link
Member

@ppvg ppvg commented Jan 21, 2025

Convert some of the Button documentation pages to markdown as a Proof of Concept.

  • Uses mdsvex to render markdown routes.
  • Uses frontmatter:
    • title property for page titles.
    • breadcrumb property for breadcrumb names (defaults to title if omitted).
    • nav property for optional sidemenu (list of links).
  • Applies syntax highlighting to markdown code blocks.
  • Automatically prepends {base} to absolute link URLs.

@reinschaap
Copy link
Contributor

reinschaap commented Jan 21, 2025

Wat awesome, ik zag 2 mini dingetjes.

Echt tof opgezet zo en ik denk dat dit enorm werkbaar is!!! 👍👍💪💪🙏🙏

@reinschaap
Copy link
Contributor

Local gerunt, werkt TOP @ppvg hele goede verbetering

Base automatically changed from refactor/remove-route-groups to main January 27, 2025 14:22
ppvg and others added 2 commits January 27, 2025 15:31
Co-authored-by: Rein Schaap <[email protected]>
Co-authored-by: Rein Schaap <[email protected]>
@ppvg ppvg requested review from reinschaap and randh1r January 27, 2025 14:34
@ppvg ppvg marked this pull request as ready for review January 27, 2025 14:34
@ppvg ppvg requested a review from a team as a code owner January 27, 2025 14:34
Copy link

@randh1r randh1r left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ppvg ppvg mentioned this pull request Jan 30, 2025
3 tasks
@ppvg ppvg merged commit b2803ba into main Jan 30, 2025
6 checks passed
@ppvg ppvg deleted the feat/markdown branch January 30, 2025 07:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants