Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Yue Sun
authored and
Yue Sun
committed
Oct 15, 2023
0 parents
commit 0d478d1
Showing
10 changed files
with
1,301 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,66 @@ | ||
# Sample workflow for building and deploying a VitePress site to GitHub Pages | ||
# | ||
name: Deploy VitePress site to Pages | ||
|
||
on: | ||
# Runs on pushes targeting the `main` branch. Change this to `master` if you're | ||
# using the `master` branch as the default branch. | ||
push: | ||
branches: [main] | ||
|
||
# Allows you to run this workflow manually from the Actions tab | ||
workflow_dispatch: | ||
|
||
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
concurrency: | ||
group: pages | ||
cancel-in-progress: false | ||
|
||
jobs: | ||
# Build job | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
with: | ||
fetch-depth: 0 # Not needed if lastUpdated is not enabled | ||
# - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm | ||
# - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun | ||
- name: Setup Node | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: 18 | ||
cache: npm # or pnpm / yarn | ||
- name: Setup Pages | ||
uses: actions/configure-pages@v3 | ||
- name: Install dependencies | ||
run: npm ci # or pnpm install / yarn install / bun install | ||
- name: Build with VitePress | ||
run: | | ||
npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build | ||
touch docs/.vitepress/dist/.nojekyll | ||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v2 | ||
with: | ||
path: docs/.vitepress/dist | ||
|
||
# Deployment job | ||
deploy: | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
needs: build | ||
runs-on: ubuntu-latest | ||
name: Deploy | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v2 |
This file contains 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,17 @@ | ||
# Ignore node_modules | ||
node_modules/ | ||
|
||
# Ignore build output | ||
dist/ | ||
|
||
# Ignore cache | ||
cache/ | ||
|
||
# Ignore .DS_Store files (macOS) | ||
.DS_Store | ||
|
||
# Ignore Thumbs.db files (Windows) | ||
Thumbs.db | ||
|
||
# Ignore .vitepress/temp files | ||
.vitepress/temp/ |
This file contains 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,30 @@ | ||
import { defineConfig } from 'vitepress' | ||
|
||
// https://vitepress.dev/reference/site-config | ||
export default defineConfig({ | ||
title: "Suny's Blog", | ||
description: "Programming, Life, and Everything in Between", | ||
themeConfig: { | ||
// https://vitepress.dev/reference/default-theme-config | ||
nav: [ | ||
{ text: 'Home', link: '/' }, | ||
{ text: 'Examples', link: '/markdown-examples' }, | ||
{ text: 'About', link: '/markdown-examples' } | ||
], | ||
|
||
sidebar: [ | ||
{ | ||
text: 'Examples', | ||
items: [ | ||
{ text: 'Markdown Examples', link: '/markdown-examples' }, | ||
{ text: 'Runtime API Examples', link: '/api-examples' } | ||
] | ||
} | ||
], | ||
|
||
socialLinks: [ | ||
{ icon: 'github', link: 'https://github.com/euynus' }, | ||
{ icon: 'twitter', link: 'https://twitter.com/euynuss' }, | ||
] | ||
} | ||
}) |
This file contains 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,16 @@ | ||
// https://vitepress.dev/guide/custom-theme | ||
import { h } from 'vue' | ||
import Theme from 'vitepress/theme' | ||
import './style.css' | ||
|
||
export default { | ||
extends: Theme, | ||
Layout: () => { | ||
return h(Theme.Layout, null, { | ||
// https://vitepress.dev/guide/extending-default-theme#layout-slots | ||
}) | ||
}, | ||
enhanceApp({ app, router, siteData }) { | ||
// ... | ||
} | ||
} |
This file contains 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,139 @@ | ||
/** | ||
* Customize default theme styling by overriding CSS variables: | ||
* https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css | ||
*/ | ||
|
||
/** | ||
* Colors | ||
* | ||
* Each colors have exact same color scale system with 3 levels of solid | ||
* colors with different brightness, and 1 soft color. | ||
* | ||
* - `XXX-1`: The most solid color used mainly for colored text. It must | ||
* satisfy the contrast ratio against when used on top of `XXX-soft`. | ||
* | ||
* - `XXX-2`: The color used mainly for hover state of the button. | ||
* | ||
* - `XXX-3`: The color for solid background, such as bg color of the button. | ||
* It must satisfy the contrast ratio with pure white (#ffffff) text on | ||
* top of it. | ||
* | ||
* - `XXX-soft`: The color used for subtle background such as custom container | ||
* or badges. It must satisfy the contrast ratio when putting `XXX-1` colors | ||
* on top of it. | ||
* | ||
* The soft color must be semi transparent alpha channel. This is crucial | ||
* because it allows adding multiple "soft" colors on top of each other | ||
* to create a accent, such as when having inline code block inside | ||
* custom containers. | ||
* | ||
* - `default`: The color used purely for subtle indication without any | ||
* special meanings attched to it such as bg color for menu hover state. | ||
* | ||
* - `brand`: Used for primary brand colors, such as link text, button with | ||
* brand theme, etc. | ||
* | ||
* - `tip`: Used to indicate useful information. The default theme uses the | ||
* brand color for this by default. | ||
* | ||
* - `warning`: Used to indicate warning to the users. Used in custom | ||
* container, badges, etc. | ||
* | ||
* - `danger`: Used to show error, or dangerous message to the users. Used | ||
* in custom container, badges, etc. | ||
* -------------------------------------------------------------------------- */ | ||
|
||
:root { | ||
--vp-c-default-1: var(--vp-c-gray-1); | ||
--vp-c-default-2: var(--vp-c-gray-2); | ||
--vp-c-default-3: var(--vp-c-gray-3); | ||
--vp-c-default-soft: var(--vp-c-gray-soft); | ||
|
||
--vp-c-brand-1: var(--vp-c-indigo-1); | ||
--vp-c-brand-2: var(--vp-c-indigo-2); | ||
--vp-c-brand-3: var(--vp-c-indigo-3); | ||
--vp-c-brand-soft: var(--vp-c-indigo-soft); | ||
|
||
--vp-c-tip-1: var(--vp-c-brand-1); | ||
--vp-c-tip-2: var(--vp-c-brand-2); | ||
--vp-c-tip-3: var(--vp-c-brand-3); | ||
--vp-c-tip-soft: var(--vp-c-brand-soft); | ||
|
||
--vp-c-warning-1: var(--vp-c-yellow-1); | ||
--vp-c-warning-2: var(--vp-c-yellow-2); | ||
--vp-c-warning-3: var(--vp-c-yellow-3); | ||
--vp-c-warning-soft: var(--vp-c-yellow-soft); | ||
|
||
--vp-c-danger-1: var(--vp-c-red-1); | ||
--vp-c-danger-2: var(--vp-c-red-2); | ||
--vp-c-danger-3: var(--vp-c-red-3); | ||
--vp-c-danger-soft: var(--vp-c-red-soft); | ||
} | ||
|
||
/** | ||
* Component: Button | ||
* -------------------------------------------------------------------------- */ | ||
|
||
:root { | ||
--vp-button-brand-border: transparent; | ||
--vp-button-brand-text: var(--vp-c-white); | ||
--vp-button-brand-bg: var(--vp-c-brand-3); | ||
--vp-button-brand-hover-border: transparent; | ||
--vp-button-brand-hover-text: var(--vp-c-white); | ||
--vp-button-brand-hover-bg: var(--vp-c-brand-2); | ||
--vp-button-brand-active-border: transparent; | ||
--vp-button-brand-active-text: var(--vp-c-white); | ||
--vp-button-brand-active-bg: var(--vp-c-brand-1); | ||
} | ||
|
||
/** | ||
* Component: Home | ||
* -------------------------------------------------------------------------- */ | ||
|
||
:root { | ||
--vp-home-hero-name-color: transparent; | ||
--vp-home-hero-name-background: -webkit-linear-gradient( | ||
120deg, | ||
#bd34fe 30%, | ||
#41d1ff | ||
); | ||
|
||
--vp-home-hero-image-background-image: linear-gradient( | ||
-45deg, | ||
#bd34fe 50%, | ||
#47caff 50% | ||
); | ||
--vp-home-hero-image-filter: blur(40px); | ||
} | ||
|
||
@media (min-width: 640px) { | ||
:root { | ||
--vp-home-hero-image-filter: blur(56px); | ||
} | ||
} | ||
|
||
@media (min-width: 960px) { | ||
:root { | ||
--vp-home-hero-image-filter: blur(72px); | ||
} | ||
} | ||
|
||
/** | ||
* Component: Custom Block | ||
* -------------------------------------------------------------------------- */ | ||
|
||
:root { | ||
--vp-custom-block-tip-border: transparent; | ||
--vp-custom-block-tip-text: var(--vp-c-text-1); | ||
--vp-custom-block-tip-bg: var(--vp-c-brand-soft); | ||
--vp-custom-block-tip-code-bg: var(--vp-c-brand-soft); | ||
} | ||
|
||
/** | ||
* Component: Algolia | ||
* -------------------------------------------------------------------------- */ | ||
|
||
.DocSearch { | ||
--docsearch-primary-color: var(--vp-c-brand-1) !important; | ||
} | ||
|
This file contains 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,49 @@ | ||
--- | ||
outline: deep | ||
--- | ||
|
||
# Runtime API Examples | ||
|
||
This page demonstrates usage of some of the runtime APIs provided by VitePress. | ||
|
||
The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files: | ||
|
||
```md | ||
<script setup> | ||
import { useData } from 'vitepress' | ||
|
||
const { theme, page, frontmatter } = useData() | ||
</script> | ||
|
||
## Results | ||
|
||
### Theme Data | ||
<pre>{{ theme }}</pre> | ||
|
||
### Page Data | ||
<pre>{{ page }}</pre> | ||
|
||
### Page Frontmatter | ||
<pre>{{ frontmatter }}</pre> | ||
``` | ||
|
||
<script setup> | ||
import { useData } from 'vitepress' | ||
|
||
const { site, theme, page, frontmatter } = useData() | ||
</script> | ||
|
||
## Results | ||
|
||
### Theme Data | ||
<pre>{{ theme }}</pre> | ||
|
||
### Page Data | ||
<pre>{{ page }}</pre> | ||
|
||
### Page Frontmatter | ||
<pre>{{ frontmatter }}</pre> | ||
|
||
## More | ||
|
||
Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata). |
This file contains 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,35 @@ | ||
--- | ||
# https://vitepress.dev/reference/default-theme-home-page | ||
layout: home | ||
|
||
hero: | ||
name: "My Awesome Project" | ||
text: "A VitePress Site" | ||
tagline: My great project tagline | ||
actions: | ||
- theme: brand | ||
text: Markdown Examples | ||
link: /markdown-examples | ||
- theme: alt | ||
text: API Examples | ||
link: /api-examples | ||
|
||
features: | ||
- title: Feature A | ||
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
- title: Feature B | ||
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
- title: Feature C | ||
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
- title: Feature C | ||
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
- title: Feature C | ||
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
- title: Feature C | ||
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
- title: Feature C | ||
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
- title: Feature C | ||
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit | ||
--- | ||
|
Oops, something went wrong.