Skip to content

Commit

Permalink
docs(site): import core package of this project
Browse files Browse the repository at this point in the history
  • Loading branch information
akinoccc committed Apr 10, 2024
1 parent 40b841b commit 8f83a57
Show file tree
Hide file tree
Showing 6 changed files with 67 additions and 5 deletions.
17 changes: 12 additions & 5 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ export default defineConfig({
'edit-on-github': '在 Github 中编辑',
'copy-code': '复制代码',
'copy-success': '复制成功',
'copy-error': '复制失败'
}
'copy-error': '复制失败',
},
},

// https://vitepress.dev/reference/default-theme-config
Expand All @@ -51,10 +51,17 @@ export default defineConfig({
markdown: {
config: (md) => {
md.use(demoblockPlugin)
}
},
},
vite: {
plugins: [demoblockVitePlugin()]

resolve: {
alias: {
'@': new URL('../../package', import.meta.url).pathname,
},
extensions: ['.mjs', '.js', '.ts', '.jsx', '.tsx', '.json', '.vue', '.less'],
},
plugins: [demoblockVitePlugin()],
},
vue: {}
vue: {},
})
46 changes: 46 additions & 0 deletions docs/guide/quick-start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
outline: deep
---

## Installation

```shell
npm i vue3-styled-components
```

```shell
yarn add vue3-styled-components
```

```shell
pnpm i vue3-styled-components
```

## Getting Started

:::demo

```vue
<script setup lang="ts">
import { styled } from '@vue3-styled-components/package'
const StyledDiv = styled.div`
display: flex;
justify-content: center;
align-items: center;
padding: 20px;
border-radius: 9999px;
background-color: #4c5a6d;
font-size: 20px;
font-weight: bold;
color: #fff;
`
</script>
<template>
<StyledDiv>Hello World!</StyledDiv>
</template>
```

:::
3 changes: 3 additions & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,8 @@
"devDependencies": {
"vitepress": "^1.0.2",
"vitepress-theme-demoblock": "^3.0.7"
},
"dependencies": {
"@vue3-styled-components/package": "workspace:^"
}
}
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
],
"scripts": {
"dev": "cd example && pnpm run dev",
"docs:dev": "cd docs && pnpm run docs:dev",
"typecheck": "vue-tsc --noEmit",
"lint": "eslint . -c .eslintrc.json --fix --ext .ts,.vue,.tsx,.d.ts",
"prepare": "husky install"
Expand Down
1 change: 1 addition & 0 deletions package/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@
"version": "0.0.2",
"description": "",
"type": "module",
"main": "index.ts",
"scripts": {}
}
4 changes: 4 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 8f83a57

Please sign in to comment.