-
-
Notifications
You must be signed in to change notification settings - Fork 66
chore: migrate to shadcn-docs #519
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,24 @@ | ||
node_modules | ||
.nuxt | ||
# Nuxt dev/build outputs | ||
.output | ||
.data | ||
.nuxt | ||
.nitro | ||
.cache | ||
dist | ||
|
||
# Node dependencies | ||
node_modules | ||
|
||
# Logs | ||
logs | ||
*.log | ||
|
||
# Misc | ||
.DS_Store | ||
.fleet | ||
.idea | ||
|
||
# Local env files | ||
.env | ||
.env.* | ||
!.env.example |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"recommendations": [ | ||
"nuxt.mdc" | ||
] | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
export default defineAppConfig({ | ||
shadcnDocs: { | ||
site: { | ||
name: 'magic-regexp', | ||
description: 'Beautifully designed Nuxt Content template built with shadcn-vue. Customizable. Compatible. Open Source.', | ||
ogImageComponent: 'ShadcnDocs', | ||
ogImageColor: 'dark', | ||
}, | ||
theme: { | ||
customizable: false, | ||
color: '', | ||
radius: 0.5, | ||
}, | ||
header: { | ||
title: 'magic-regexp', | ||
showTitle: true, | ||
darkModeToggle: true, | ||
logo: { | ||
light: '/logo.svg', | ||
dark: '/logo.svg', | ||
}, | ||
nav: [], | ||
links: [{ | ||
icon: 'lucide:github', | ||
to: 'https://github.com/unjs/magic-regexp', | ||
target: '_blank', | ||
}], | ||
}, | ||
aside: { | ||
useLevel: true, | ||
collapse: false, | ||
}, | ||
main: { | ||
breadCrumb: true, | ||
showTitle: true, | ||
}, | ||
footer: { | ||
credits: 'Made with ❤️. Copyright © 2025 Daniel Roe', | ||
links: [{ | ||
icon: 'lucide:github', | ||
to: 'https://github.com/unjs/magic-regexp', | ||
target: '_blank', | ||
}], | ||
}, | ||
toc: { | ||
enable: true, | ||
title: 'On This Page', | ||
links: [{ | ||
title: 'Star on GitHub', | ||
icon: 'lucide:star', | ||
to: 'https://github.com/unjs/magic-regexp', | ||
target: '_blank', | ||
}, { | ||
title: 'Create Issues', | ||
icon: 'lucide:circle-dot', | ||
to: 'https://github.com/unjs/magic-regexp/issues', | ||
target: '_blank', | ||
}], | ||
}, | ||
search: { | ||
enable: true, | ||
inAside: false, | ||
}, | ||
}, | ||
}) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
@tailwind base; | ||
@tailwind components; | ||
@tailwind utilities; | ||
|
||
|
||
@layer base { | ||
:root { | ||
--background: 0 0% 100%; | ||
--foreground: 240 10% 3.9%; | ||
|
||
--card: 0 0% 100%; | ||
--card-foreground: 240 10% 3.9%; | ||
|
||
--popover: 0 0% 100%; | ||
--popover-foreground: 240 10% 3.9%; | ||
|
||
--primary: 320 90% 60%; | ||
--primary-foreground: 0 0% 100%; | ||
|
||
--secondary: 240 4.8% 95.9%; | ||
--secondary-foreground: 240 5.9% 10%; | ||
|
||
--muted: 240 4.8% 95.9%; | ||
--muted-foreground: 240 3.8% 46.1%; | ||
|
||
--accent: 240 4.8% 95.9%; | ||
--accent-foreground: 240 5.9% 10%; | ||
|
||
--destructive: 0 84.2% 60.2%; | ||
--destructive-foreground: 0 0% 98%; | ||
|
||
--border:240 5.9% 10%; | ||
--input:240 5.9% 90%; | ||
--ring:240 5.9% 10%; | ||
--radius: 0.5rem; | ||
} | ||
|
||
.dark { | ||
--background:240 10% 3.9%; | ||
--foreground:0 0% 98%; | ||
|
||
--card:240 10% 3.9%; | ||
--card-foreground:0 0% 98%; | ||
|
||
--popover:240 10% 3.9%; | ||
--popover-foreground:0 0% 98%; | ||
|
||
--primary: 320 90% 60%; | ||
--primary-foreground: 0 0% 100%; | ||
|
||
--secondary:240 3.7% 15.9%; | ||
--secondary-foreground:0 0% 98%; | ||
|
||
--muted:240 3.7% 15.9%; | ||
--muted-foreground:240 5% 64.9%; | ||
|
||
--accent:240 3.7% 15.9%; | ||
--accent-foreground:0 0% 98%; | ||
|
||
--destructive:0 62.8% 30.6%; | ||
--destructive-foreground:0 0% 98%; | ||
|
||
--border:240 3.7% 15.9%; | ||
--input:240 3.7% 15.9%; | ||
--ring:240 4.9% 83.9%; | ||
} | ||
} | ||
|
||
|
||
@layer utilities { | ||
.step { | ||
counter-increment: step; | ||
} | ||
|
||
.step:before { | ||
@apply absolute w-9 h-9 bg-muted rounded-full font-mono font-medium text-center text-base inline-flex items-center justify-center -indent-px border-4 border-background; | ||
@apply -ml-[50px] -mt-1; | ||
content: counter(step); | ||
} | ||
} | ||
|
||
@layer base { | ||
* { | ||
@apply border-border; | ||
} | ||
|
||
body { | ||
@apply bg-background text-foreground; | ||
} | ||
} |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
--- | ||
title: Home | ||
navigation: false | ||
--- | ||
|
||
::hero | ||
--- | ||
actions: | ||
- name: Documentation | ||
leftIcon: 'lucide:rocket' | ||
to: /guide | ||
- name: Try it out | ||
leftIcon: 'lucide:play' | ||
variant: outline | ||
to: https://stackblitz.com/github/unjs/magic-regexp/tree/main/playground | ||
--- | ||
|
||
#title | ||
magic-regexp | ||
|
||
#description | ||
A compiled-away, type-safe, readable RegExp alternative. | ||
:: | ||
|
||
::card-group | ||
::card | ||
--- | ||
icon: 'heroicons-cube-transparent' | ||
icon-size: 26 | ||
--- | ||
|
||
#title | ||
Lightweight runtime | ||
|
||
#description | ||
Zero-dependency, minimal runtime if no transform is used. | ||
:: | ||
|
||
::card | ||
--- | ||
icon: 'heroicons-wrench' | ||
icon-size: 26 | ||
--- | ||
|
||
#title | ||
... or pure RegExp | ||
|
||
#description | ||
Ships with transform to compile to pure regular expression. | ||
:: | ||
|
||
::card | ||
--- | ||
icon: 'heroicons-shield-check' | ||
icon-size: 26 | ||
--- | ||
|
||
#title | ||
Type-safe | ||
|
||
#description | ||
Automatically typed capture groups, with generated RegExp displaying on hover. | ||
:: | ||
|
||
::card | ||
--- | ||
icon: 'heroicons-book-open' | ||
icon-size: 26 | ||
--- | ||
|
||
#title | ||
Intuitive syntax | ||
|
||
#description | ||
Natural language syntax regular expression builder. | ||
:: | ||
:: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,19 @@ | ||
{ | ||
"name": "docs", | ||
"type": "module", | ||
"private": true, | ||
"scripts": { | ||
"dev": "undocs dev", | ||
"build": "undocs build", | ||
"generate": "undocs build" | ||
"build": "nuxt build", | ||
"dev": "nuxt dev", | ||
"generate": "nuxt generate", | ||
"preview": "nuxt preview", | ||
"postinstall": "nuxt prepare" | ||
}, | ||
"devDependencies": { | ||
"undocs": "0.2.30" | ||
"dependencies": { | ||
"@nuxtjs/plausible": "^1.2.0", | ||
"nuxt": "^3.16.0", | ||
"shadcn-docs-nuxt": "^0.8.21", | ||
"vue": "^3.5.13", | ||
"vue-router": "^4.5.0" | ||
} | ||
} |
Binary file not shown.
File renamed without changes
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.