Merge pull request #3 from letsescape/feature/versioning

문서, 사이드바 개선 및 설정 수정

Author: kimchanhyung98

.github/workflows/deploy.yml

@@ -3,7 +3,7 @@ name: Deploy to GitHub Pages
 on:
   push:
     branches:
-      - feature/init
+      - main
     # 특정 파일이 변경되었을 때만 실행하도록 설정할 수도 있습니다
     # paths:
     #   - docs/**

docs/index.md

@@ -0,0 +1 @@
+index.md

docusaurus.config.ts

@@ -5,9 +5,9 @@ import type * as Preset from '@docusaurus/preset-classic';
 // This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
 
 const config: Config = {
-  title: 'Laravel 한국어 문서',
-  tagline: 'PHP 웹 애플리케이션 프레임워크',
-  favicon: 'img/favicon.ico',
+  title: 'Laravel',
+  tagline: 'PHP 웹 애플리케이션 프레임워크 라라벨의 모든 것을 한글로 만나보세요',
+  favicon: 'img/favicon.png',
 
   // Set the production url of your site here
   url: 'https://laravel.chanhyung.kim',
@@ -37,41 +37,45 @@ const config: Config = {
   // may want to replace "en" with "zh-Hans".
   i18n: {
     defaultLocale: 'ko',
-    locales: ['ko', 'en'],
+    locales: ['ko'],
+    // locales: ['ko', 'en'],
   },
 
-  themes: [
-    [
-      require.resolve("@easyops-cn/docusaurus-search-local"),
-      {
-        hashed: true,
-        language: ["en", "ko"],
-        highlightSearchTermsOnTargetPage: true,
-        explicitSearchResultPath: true,
-      },
-    ],
-  ],
+  // 테마 설정
+  themes: [],
 
   plugins: [
     [
       '@docusaurus/plugin-content-docs',
       {
         id: 'default',
-        path: 'docs',
+        path: 'versioned_docs/version-12.x',
         routeBasePath: 'docs',
-        sidebarPath: './sidebars.ts',
+        sidebarPath: './versioned_sidebars/version-12.x-sidebars.json',
         // 버전 관리 설정
-        includeCurrentVersion: true,
-        lastVersion: 'current',
+        includeCurrentVersion: false,
+        lastVersion: '12.x',
         versions: {
-          current: {
+          '12.x': {
             label: '12.x',
-            path: '',
+            path: '12.x',
           },
           '11.x': {
             label: '11.x',
             path: '11.x',
           },
+          '10.x': {
+            label: '10.x',
+            path: '10.x',
+          },
+          '9.x': {
+            label: '9.x',
+            path: '9.x',
+          },
+          '8.x': {
+            label: '8.x',
+            path: '8.x',
+          },
         },
         // 기타 설정
         editUrl: 'https://github.com/letsescape/laravel-docs-web/tree/main/',
@@ -94,18 +98,53 @@ const config: Config = {
 
   themeConfig: {
     // Replace with your project's social card
-    image: 'img/laravel-social-card.jpg',
+    image: 'img/logo.png',
+
+    // 다크 모드 설정
+    colorMode: {
+      defaultMode: 'dark',     // 기본 모드를 다크로 설정
+      disableSwitch: false,    // 테마 전환 스위치 활성화
+      respectPrefersColorScheme: true,  // 사용자 시스템 설정 존중
+    },
+
+    // SEO 메타데이터
+    metadata: [
+      {name: 'keywords', content: '라라벨, Laravel, PHP 프레임워크, 웹 개발, 한글 문서, 튜토리얼, 시작하기'},
+      {name: 'description', content: '라라벨 프레임워크의 설치 방법, 기본 사용법, 주요 기능들을 한글로 쉽게 배우고 시작하세요.'},
+      {property: 'og:type', content: 'website'},
+      {property: 'og:title', content: '라라벨 한국어 문서 - PHP 웹 프레임워크'},
+      {property: 'og:description', content: '라라벨 프레임워크의 설치 방법, 기본 사용법, 주요 기능들을 한글로 쉽게 배우고 시작하세요.'},
+      {property: 'og:image', content: 'https://laravel.chanhyung.kim/img/logo.png'},
+      {name: 'twitter:card', content: 'summary_large_image'},
+      {name: 'twitter:title', content: '라라벨 한국어 문서 - PHP 웹 프레임워크'},
+      {name: 'twitter:description', content: '라라벨 프레임워크의 설치 방법, 기본 사용법, 주요 기능들을 한글로 쉽게 배우고 시작하세요.'},
+      {name: 'twitter:image', content: 'https://laravel.chanhyung.kim/img/logo.png'},
+    ],
+
+    // Algolia DocSearch 설정
+    algolia: {
+      // The application ID provided by Algolia
+      appId: 'P3AV656TKT',
+      // Public API key: it is safe to commit it
+      apiKey: '36cb770af37e1af6373a80778092f985',
+      indexName: 'laravel-chanhyung',
+      // 검색 결과 페이지 경로 설정
+      searchPagePath: 'search',
+      // 사용자 검색 분석 기능 활성화
+      insights: true,
+    },
 
     navbar: {
-      title: 'Laravel 한국어 문서',
+      title: null,
       logo: {
         alt: 'Laravel Logo',
-        src: 'img/logo.svg',
+        src: 'img/title_large.svg',
+        srcDark: 'img/title_large.svg',
+        className: 'navbar-logo',
       },
       items: [
         {
-          type: 'docSidebar',
-          sidebarId: 'tutorialSidebar',
+          to: '/docs/12.x',
           position: 'left',
           label: '문서',
         },
@@ -119,26 +158,28 @@ const config: Config = {
           type: 'localeDropdown',
           position: 'right',
         },
-        {
-          href: 'https://github.com/letsescape/laravel-docs-web',
-          label: 'GitHub',
-          position: 'right',
-        },
+
       ],
     },
     footer: {
       style: 'dark',
+      logo: {
+        alt: 'Laravel Logo',
+        src: 'img/title_large.svg',
+        href: '/',
+        className: 'footer-logo',
+      },
       links: [
         {
           title: '문서',
           items: [
             {
               label: '시작하기',
-              to: '/docs/intro',
+              to: '/docs/12.x/intro',
             },
             {
               label: '아키텍처 개념',
-              to: '/docs/architecture/container',
+              to: '/docs/12.x/architecture/container',
             },
           ],
         },
@@ -161,7 +202,7 @@ const config: Config = {
           ],
         },
       ],
-      copyright: `Copyright © ${new Date().getFullYear()} Laravel 한국어 문서. Built with Docusaurus.`,
+      copyright: `Copyright © 2025 kimchanhyung98. Built with Docusaurus.`,
     },
     prism: {
       theme: prismThemes.github,

package.json

@@ -13,7 +13,8 @@
     "serve": "docusaurus serve",
     "write-translations": "docusaurus write-translations",
     "write-heading-ids": "docusaurus write-heading-ids",
-    "typecheck": "tsc"
+    "typecheck": "tsc",
+    "generate-sidebars": "node scripts/generate-sidebars.js"
   },
   "repository": {
     "type": "git",

scripts/generate-sidebars.js

@@ -0,0 +1,100 @@
+/**
+ * Script to generate sidebar files for each version based on origin/documentation.md files
+ */
+const fs = require('fs');
+const path = require('path');
+
+// Versions to process
+const versions = ['8.x', '9.x', '10.x', '11.x', '12.x'];
+
+// Function to parse documentation.md and create sidebar structure
+function parseSidebar(docContent, version) {
+  const lines = docContent.split('\n');
+  const sidebar = {
+    tutorialSidebar: []
+  };
+
+  let currentCategory = null;
+
+  for (const line of lines) {
+    // Match main category
+    const categoryMatch = line.match(/^- ## (.+)$/);
+    if (categoryMatch) {
+      currentCategory = {
+        type: 'category',
+        label: categoryMatch[1],
+        collapsed: true,
+        items: []
+      };
+      sidebar.tutorialSidebar.push(currentCategory);
+      continue;
+    }
+
+    // Match items within a category
+    const itemMatch = line.match(/^\s+- \[(.+)\]\(\/docs\/\{\{version\}\}\/(.+)\)$/);
+    if (itemMatch && currentCategory) {
+      const itemLabel = itemMatch[1];
+      let itemPath = itemMatch[2];
+
+      // Remove any anchor links from the path (e.g., 'starter-kits#laravel-breeze' -> 'starter-kits')
+      if (itemPath.includes('#')) {
+        itemPath = itemPath.split('#')[0];
+      }
+
+      currentCategory.items.push(itemPath);
+      continue;
+    }
+
+    // Match API Documentation link (outside of any category)
+    const apiDocsMatch = line.match(/^- \[API Documentation\]\((.+)\)$/);
+    if (apiDocsMatch) {
+      let apiUrl = apiDocsMatch[1];
+      // If URL contains a version placeholder, replace it with the actual version
+      if (apiUrl.includes('{{version}}')) {
+        apiUrl = apiUrl.replace('{{version}}', version);
+      }
+
+      // Add API Documentation as a link item
+      sidebar.tutorialSidebar.push({
+        type: 'link',
+        label: 'API Documentation',
+        href: apiUrl
+      });
+    }
+  }
+
+  return sidebar;
+}
+
+// Process each version
+versions.forEach(version => {
+  const docPath = path.join(__dirname, '..', 'versioned_docs', `version-${version}`, 'origin', 'documentation.md');
+  const sidebarOutputPath = path.join(__dirname, '..', 'versioned_sidebars', `version-${version}-sidebars.json`);
+
+  // Create directory if it doesn't exist
+  const sidebarDir = path.dirname(sidebarOutputPath);
+  if (!fs.existsSync(sidebarDir)) {
+    fs.mkdirSync(sidebarDir, { recursive: true });
+  }
+
+  try {
+    if (fs.existsSync(docPath)) {
+      const docContent = fs.readFileSync(docPath, 'utf8');
+      const sidebar = parseSidebar(docContent, version);
+
+      // Set first category to be expanded by default
+      if (sidebar.tutorialSidebar.length > 0) {
+        sidebar.tutorialSidebar[1].collapsed = false;
+      }
+
+      fs.writeFileSync(sidebarOutputPath, JSON.stringify(sidebar, null, 2));
+      console.log(`Generated sidebar for version ${version}`);
+    } else {
+      console.warn(`Documentation file not found for version ${version}`);
+    }
+  } catch (error) {
+    console.error(`Error processing version ${version}:`, error);
+  }
+});
+
+console.log('Sidebar generation complete!');