Amadeus
/
blog
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add some comments to `config.ts`

This commit is contained in:
saicaca 2024-05-01 12:35:36 +08:00
parent 9761ed75c5
commit 5e4ae01af6
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/config.ts
View File

@ -9,14 +9,14 @@ import { LinkPreset } from './types/config'
export const siteConfig: SiteConfig = { export const siteConfig: SiteConfig = {
title: 'Fuwari', title: 'Fuwari',
subtitle: 'Demo Site', subtitle: 'Demo Site',
lang: 'en', lang: 'en', // 'en', 'zh_CN', 'zh_TW', 'ja'
themeColor: { themeColor: {
hue: 250, // Default hue for the theme color, from 0 to 360. e.g. red: 0, teal: 200, cyan: 250, pink: 345 hue: 250, // Default hue for the theme color, from 0 to 360. e.g. red: 0, teal: 200, cyan: 250, pink: 345
fixed: false, // Hide the theme color picker for visitors fixed: false, // Hide the theme color picker for visitors
}, },
banner: { banner: {
enable: false, enable: false,
src: 'assets/images/demo-banner.png', src: 'assets/images/demo-banner.png', // Relative to the /src directory. Relative to the /public directory if it starts with '/'
}, },
favicon: [ // Leave this array empty to use the default favicon favicon: [ // Leave this array empty to use the default favicon
// { // {
@ -34,20 +34,22 @@ export const navBarConfig: NavBarConfig = {
LinkPreset.About, LinkPreset.About,
{ {
name: 'GitHub', name: 'GitHub',
url: 'https://github.com/saicaca/fuwari', url: 'https://github.com/saicaca/fuwari', // Internal links should not include the base path, as it is automatically added
external: true, external: true, // Show an external link icon and will open in a new tab
}, },
], ],
} }
export const profileConfig: ProfileConfig = { export const profileConfig: ProfileConfig = {
avatar: 'assets/images/demo-avatar.png', avatar: 'assets/images/demo-avatar.png', // Relative to the /src directory. Relative to the /public directory if it starts with '/'
name: 'Lorem Ipsum', name: 'Lorem Ipsum',
bio: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', bio: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
links: [ links: [
{ {
name: 'Twitter', name: 'Twitter',
icon: 'fa6-brands:twitter', icon: 'fa6-brands:twitter', // Visit https://icones.js.org/ for icon codes
// You will need to install the corresponding icon set if it's not already included
// `pnpm add @iconify-json/<icon-set-name>`
url: 'https://twitter.com', url: 'https://twitter.com',
}, },
{ {