Skip to content

Commit 26afa71

Browse files
committed
Feat init Docusaurus for Laravel
1 parent e15b183 commit 26afa71

File tree

17 files changed

+18369
-0
lines changed

17 files changed

+18369
-0
lines changed

.gitignore

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
# Logs
19+
npm-debug.log*
20+
yarn-debug.log*
21+
yarn-error.log*
22+
23+
# IDE specific files
24+
.idea
25+
.vscode
26+
*.swp
27+
*.swo
28+
29+
# Local Netlify folder
30+
.netlify

.idea/.gitignore

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/intro.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Laravel 소개
6+
7+
Laravel은 웹 애플리케이션 개발을 위한 접근성, 강력함, 그리고 유연성을 제공하는 웹 애플리케이션 프레임워크입니다. 우아한 문법을 가진 Laravel은 우리가 창의성을 표현하고 즐겁게 작업할 수 있도록 도와줍니다. 이것이 바로 Laravel의 철학입니다.
8+
9+
## 시작하기
10+
11+
Laravel 설치 및 기본 사용법에 대해 알아보세요.
12+
13+
```bash
14+
composer create-project laravel/laravel example-app
15+
cd example-app
16+
php artisan serve
17+
```
18+
19+
## 주요 기능
20+
21+
Laravel은 다음과 같은 강력한 기능을 제공합니다:
22+
23+
- 강력한 라우팅 시스템
24+
- 블레이드 템플릿 엔진
25+
- 엘로퀀트 ORM
26+
- 아티산 CLI
27+
- 마이그레이션 시스템
28+
- 이벤트 및 큐 시스템
29+
- 테스팅 지원
30+
31+
## 더 알아보기
32+
33+
Laravel의 공식 문서를 통해 더 많은 정보를 얻을 수 있습니다.

docusaurus.config.js

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
// @ts-check
2+
// Note: type annotations allow type checking and IDEs autocompletion
3+
4+
const {themes} = require('prism-react-renderer');
5+
const lightTheme = themes.github;
6+
const darkTheme = themes.dracula;
7+
8+
/** @type {import('@docusaurus/types').Config} */
9+
const config = {
10+
title: 'Laravel Korean Documentation',
11+
tagline: 'Laravel 한국어 문서',
12+
favicon: 'img/favicon.ico',
13+
14+
// Set the production url of your site here
15+
url: 'https://your-docusaurus-site.example.com',
16+
// Set the /<baseUrl>/ pathname under which your site is served
17+
// For GitHub pages deployment, it is often '/<projectName>/'
18+
baseUrl: '/',
19+
20+
// GitHub pages deployment config.
21+
// If you aren't using GitHub pages, you don't need these.
22+
organizationName: 'letsescape', // Usually your GitHub org/user name.
23+
projectName: 'laravel-docs-web', // Usually your repo name.
24+
25+
onBrokenLinks: 'throw',
26+
onBrokenMarkdownLinks: 'warn',
27+
28+
// Even if you don't use internalization, you can use this field to set useful
29+
// metadata like html lang. For example, if your site is Chinese, you may want
30+
// to replace "en" with "zh-Hans".
31+
i18n: {
32+
defaultLocale: 'ko',
33+
locales: ['ko'],
34+
},
35+
36+
presets: [
37+
[
38+
'classic',
39+
/** @type {import('@docusaurus/preset-classic').Options} */
40+
({
41+
docs: {
42+
sidebarPath: require.resolve('./sidebars.js'),
43+
// Please change this to your repo.
44+
// Remove this to remove the "edit this page" links.
45+
editUrl:
46+
'https://github.com/letsescape/laravel-docs-web/tree/main/',
47+
},
48+
blog: {
49+
showReadingTime: true,
50+
// Please change this to your repo.
51+
// Remove this to remove the "edit this page" links.
52+
editUrl:
53+
'https://github.com/letsescape/laravel-docs-web/tree/main/',
54+
},
55+
theme: {
56+
customCss: require.resolve('./src/css/custom.css'),
57+
},
58+
}),
59+
],
60+
],
61+
62+
themeConfig:
63+
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
64+
({
65+
// Replace with your project's social card
66+
image: 'img/docusaurus-social-card.jpg',
67+
navbar: {
68+
title: 'Laravel 한국어 문서',
69+
logo: {
70+
alt: 'Laravel Logo',
71+
src: 'img/logo.svg',
72+
},
73+
items: [
74+
{
75+
type: 'docSidebar',
76+
sidebarId: 'tutorialSidebar',
77+
position: 'left',
78+
label: '문서',
79+
},
80+
{to: '/blog', label: '블로그', position: 'left'},
81+
{
82+
href: 'https://github.com/letsescape/laravel-docs-web',
83+
label: 'GitHub',
84+
position: 'right',
85+
},
86+
],
87+
},
88+
footer: {
89+
style: 'dark',
90+
links: [
91+
{
92+
title: '문서',
93+
items: [
94+
{
95+
label: '시작하기',
96+
to: '/docs/intro',
97+
},
98+
],
99+
},
100+
{
101+
title: '커뮤니티',
102+
items: [
103+
{
104+
label: 'Laravel Korea',
105+
href: 'https://laravel.kr',
106+
},
107+
],
108+
},
109+
{
110+
title: '더 보기',
111+
items: [
112+
{
113+
label: '블로그',
114+
to: '/blog',
115+
},
116+
{
117+
label: 'GitHub',
118+
href: 'https://github.com/letsescape/laravel-docs-web',
119+
},
120+
],
121+
},
122+
],
123+
copyright: `Copyright © ${new Date().getFullYear()} Laravel Korea Community. Built with Docusaurus.`,
124+
},
125+
prism: {
126+
theme: lightTheme,
127+
darkTheme: darkTheme,
128+
},
129+
}),
130+
};
131+
132+
module.exports = config;

0 commit comments

Comments
 (0)