diff --git a/.prettierrc.json b/.prettierrc.json index 8b3cc811..04e0133a 100644 --- a/.prettierrc.json +++ b/.prettierrc.json @@ -3,5 +3,6 @@ "semi": false, "tabWidth": 2, "printWidth": 100, - "trailingComma": "none" -} \ No newline at end of file + "trailingComma": "none", + "singleQuote": true +} diff --git a/README.md b/README.md index 5ca26811..4cdad1eb 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ https://vitepress.dev/guide/markdown - 節タイトルは内容を簡潔に表したものにしてください - その１，その２みたいなのは出来るだけ避ける - container（`:::info` など）は以下の方針を目安に利用してください - - tips: 注釈（git/cliの操作法など） + - tip: 注釈（git/cliの操作法など） - info: 発展的な内容、コラム - warning: 注意事項（気をつけないと正常に実行できないことがあるもの） - danger: 破壊的な事象（サーバーに負荷を与える操作など） diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 2f35f044..a16d0601 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -1,40 +1,40 @@ -import { defineConfig } from "vitepress" -import { chapter1SidebarItems } from "./sidebarConfigs/chapters/chapter1/chapter1" +import { defineConfig } from 'vitepress' +import { chapter1SidebarItems } from './sidebarConfigs/chapters/chapter1/chapter1' // https://vitepress.dev/reference/site-config export default defineConfig({ - base: "/naro-text/", - title: "なろう講習会", - description: "Webエンジニアになろう講習会のテキスト", - head: [["link", { rel: "icon", href: "/naro-text/favicon.ico" }]], + base: '/naro-text/', + title: 'なろう講習会', + description: 'Webエンジニアになろう講習会のテキスト', + head: [['link', { rel: 'icon', href: '/naro-text/favicon.ico' }]], themeConfig: { // https://vitepress.dev/reference/default-theme-config - nav: [{ text: "Home", link: "/" }], + nav: [{ text: 'Home', link: '/' }], sidebar: { - "/chapter1/": chapter1SidebarItems + '/chapter1/': chapter1SidebarItems }, - socialLinks: [{ icon: "github", link: "https://github.com/traPtitech/naro-text" }], + socialLinks: [{ icon: 'github', link: 'https://github.com/traPtitech/naro-text' }], search: { - provider: "local", + provider: 'local', options: { translations: { button: { - buttonText: "検索", - buttonAriaLabel: "検索ボックスを開く" + buttonText: '検索', + buttonAriaLabel: '検索ボックスを開く' }, modal: { - displayDetails: "詳細を表示", - resetButtonTitle: "リセット", - backButtonTitle: "戻る", - noResultsText: "見つかりませんでした", + displayDetails: '詳細を表示', + resetButtonTitle: 'リセット', + backButtonTitle: '戻る', + noResultsText: '見つかりませんでした', footer: { - selectText: "選択", - selectKeyAriaLabel: "結果を選択するには、上下キーを使用します", - navigateText: "移動", - navigateUpKeyAriaLabel: "前の結果に移動するには、上キーを使用します", - navigateDownKeyAriaLabel: "次の結果に移動するには、下キーを使用します", - closeText: "閉じる" + selectText: '選択', + selectKeyAriaLabel: '結果を選択するには、上下キーを使用します', + navigateText: '移動', + navigateUpKeyAriaLabel: '前の結果に移動するには、上キーを使用します', + navigateDownKeyAriaLabel: '次の結果に移動するには、下キーを使用します', + closeText: '閉じる' } } } diff --git a/docs/.vitepress/sidebarConfigs/chapters/chapter1/chapter1.ts b/docs/.vitepress/sidebarConfigs/chapters/chapter1/chapter1.ts index 502ef975..952ff043 100644 --- a/docs/.vitepress/sidebarConfigs/chapters/chapter1/chapter1.ts +++ b/docs/.vitepress/sidebarConfigs/chapters/chapter1/chapter1.ts @@ -1,13 +1,13 @@ -import type { DefaultTheme } from "vitepress" -import { section1SidebarItems } from "./sections/section1" +import type { DefaultTheme } from 'vitepress' +import { section1SidebarItems } from './sections/section1' export const chapter1SidebarItems: DefaultTheme.SidebarItem[] = [ { - text: "第一部", + text: '第一部', items: [ - { text: "はじめに", link: "/chapter1/index" }, + { text: 'はじめに', link: '/chapter1/index' }, { - text: "実習編", + text: '実習編', collapsed: true, items: [...section1SidebarItems] } diff --git a/docs/.vitepress/sidebarConfigs/chapters/chapter1/sections/section1.ts b/docs/.vitepress/sidebarConfigs/chapters/chapter1/sections/section1.ts index e9a66cb3..4573dfc6 100644 --- a/docs/.vitepress/sidebarConfigs/chapters/chapter1/sections/section1.ts +++ b/docs/.vitepress/sidebarConfigs/chapters/chapter1/sections/section1.ts @@ -1,9 +1,9 @@ -import type { DefaultTheme } from "vitepress" +import type { DefaultTheme } from 'vitepress' export const section1SidebarItems: DefaultTheme.SidebarItem[] = [ - { text: "環境構築", link: "/chapter1/section1/setup" }, + { text: '環境構築', link: '/chapter1/section1/setup' }, { - text: "Go で Hello World", - link: "/chapter1/section1/hello-world" + text: 'Go で Hello World', + link: '/chapter1/section1/hello-world' } ] diff --git a/docs/.vitepress/theme/index.js b/docs/.vitepress/theme/index.js index 13215e96..2c3e4f4d 100644 --- a/docs/.vitepress/theme/index.js +++ b/docs/.vitepress/theme/index.js @@ -1,4 +1,4 @@ -import DefaultTheme from "vitepress/theme" -import "./trap.css" +import DefaultTheme from 'vitepress/theme' +import './trap.css' export default DefaultTheme diff --git a/docs/.vitepress/theme/trap.css b/docs/.vitepress/theme/trap.css index c7767d29..e576ec2e 100644 --- a/docs/.vitepress/theme/trap.css +++ b/docs/.vitepress/theme/trap.css @@ -176,12 +176,12 @@ * -------------------------------------------------------------------------- */ :root { - --vp-font-family-base: "Chinese Quotes", "Inter var", "Inter", ui-sans-serif, system-ui, - -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Helvetica, Arial, - "Noto Sans", sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", - "Noto Color Emoji"; - --vp-font-family-mono: ui-monospace, SFMono-Regular, "SF Mono", Menlo, Monaco, Consolas, - "Liberation Mono", "Courier New", monospace; + --vp-font-family-base: 'Chinese Quotes', 'Inter var', 'Inter', ui-sans-serif, system-ui, + -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Helvetica, Arial, + 'Noto Sans', sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', + 'Noto Color Emoji'; + --vp-font-family-mono: ui-monospace, SFMono-Regular, 'SF Mono', Menlo, Monaco, Consolas, + 'Liberation Mono', 'Courier New', monospace; } /** @@ -231,7 +231,7 @@ * -------------------------------------------------------------------------- */ :root { - --vp-header-anchor-symbol: "#"; + --vp-header-anchor-symbol: '#'; } /**