diff --git a/.gitignore b/.gitignore index ebbc8515..1ee5a591 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,4 @@ dist node_modules TODOs.md +.idea diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index 8436901e..ae677f1c 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -10,15 +10,35 @@ This section will help you build a basic VitePress documentation site from groun - **Step. 2:** Initialize with your preferred package manager. + + ```bash $ yarn init ``` + + + + ```bash + $ npm init + ``` + + - **Step. 3:** Install VitePress locally. + + ```bash $ yarn add --dev vitepress ``` + + + + ```bash + $ npm install --dev vitepress + ``` + + - **Step. 4:** Create your first document. @@ -40,9 +60,19 @@ This section will help you build a basic VitePress documentation site from groun - **Step. 6:** Serve the documentation site in the local server. + + ```bash $ yarn docs:dev ``` + + + + ```bash + $ yarn run docs:dev + ``` + + VitePress will start a hot-reloading development server at http://localhost:3000. diff --git a/src/client/app/index.ts b/src/client/app/index.ts index 5eb688e3..f4f1f0c2 100644 --- a/src/client/app/index.ts +++ b/src/client/app/index.ts @@ -9,6 +9,8 @@ import { usePageData } from './composables/pageData' import { useUpdateHead } from './composables/head' import Theme from '/@theme/index' import { usePrefetch } from './composables/preFetch' +import CodeGroup from '/@theme/components/global/CodeGroup.vue' +import CodeBlock from '/@theme/components/global/CodeBlock.vue' const NotFound = Theme.NotFound || (() => '404 Not Found') @@ -29,6 +31,8 @@ export function createApp() { handleHMR(router) const app = newApp() + app.component('CodeGroup', CodeGroup) + app.component('CodeBlock', CodeBlock) app.provide(RouterSymbol, router) diff --git a/src/client/theme-default/components/global/CodeBlock.vue b/src/client/theme-default/components/global/CodeBlock.vue new file mode 100644 index 00000000..7816d80f --- /dev/null +++ b/src/client/theme-default/components/global/CodeBlock.vue @@ -0,0 +1,32 @@ + + + + + \ No newline at end of file diff --git a/src/client/theme-default/components/global/CodeGroup.vue b/src/client/theme-default/components/global/CodeGroup.vue new file mode 100644 index 00000000..71286f28 --- /dev/null +++ b/src/client/theme-default/components/global/CodeGroup.vue @@ -0,0 +1,70 @@ + \ No newline at end of file diff --git a/src/client/theme-default/components/global/types.ts b/src/client/theme-default/components/global/types.ts new file mode 100644 index 00000000..d8041dcb --- /dev/null +++ b/src/client/theme-default/components/global/types.ts @@ -0,0 +1,5 @@ +export interface CodeGroupTabState { + title: string + index: number + content: string +}