Skip to content

Commit 928579b

Browse files
Albert-LskAlbert-Lsk
committed
docs: separate Chinese and English README files
1 parent ac06325 commit 928579b

3 files changed

Lines changed: 146 additions & 75 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,3 @@
1-
# Markdown 教程
1+
# Markdown 教程 / Markdown Tutorial
22

3-
Markdown 中文教程，完整指南。
4-
5-
[查看在线教程](https://markdown.com.cn) | [English Version](https://markdown.com.cn/en/)
6-
7-
## 特性 | Features
8-
9-
- :art: **Claude 设计风格** — 采用 Anthropic 官方设计系统
10-
- :art: **Claude Design** — Anthropic's official design system
11-
- 🌙 **深色模式** — 自动跟随系统或手动切换
12-
- 🌙 **Dark Mode** — System-aware or manual toggle
13-
- 🇨🇳🇺🇸 **中英双语** — 随时切换语言
14-
- 🇨🇳🇺🇸 **Bilingual** — Switch between Chinese and English
15-
- 💬 **评论系统** — 基于 GitHub Discussions 的 Giscus 评论
16-
- 💬 **Comments** — Giscus powered by GitHub Discussions
17-
18-
## 技术栈 | Tech Stack
19-
20-
- **框架 | Framework**: [Astro](https://astro.build)
21-
- **样式 | Styling**: [Tailwind CSS](https://tailwindcss.com)
22-
- **设计 | Design**: Claude (Anthropic)
23-
24-
## 开始使用 | Getting Started
25-
26-
```bash
27-
# 安装依赖 | Install dependencies
28-
npm install
29-
30-
# 启动开发服务器 | Start dev server
31-
npm run dev
32-
33-
# 构建生产版本 | Build for production
34-
npm run build
35-
```
36-
37-
## 项目结构 | Project Structure
38-
39-
```
40-
src/
41-
├── pages/
42-
│ ├── index.astro # 中文首页 | Chinese homepage
43-
│ ├── en/ # 英文页面 | English pages
44-
│ ├── basic/ # 基础语法 | Basic syntax
45-
│ └── extended/ # 扩展语法 | Extended syntax
46-
├── components/ # 组件 | Components
47-
├── layouts/ # 布局 | Layouts
48-
├── styles/ # 样式 | Styles
49-
└── i18n/ # 国际化 | Internationalization
50-
```
51-
52-
## 内容目录 | Content
53-
54-
### 基础语法 | Basic Syntax
55-
56-
- [标题 | Headings](https://markdown.com.cn/basic/headings)
57-
- [段落 | Paragraphs](https://markdown.com.cn/basic/paragraphs)
58-
- [换行 | Line Breaks](https://markdown.com.cn/basic/line-breaks)
59-
- [强调 | Emphasis](https://markdown.com.cn/basic/emphasis)
60-
- [引用 | Blockquotes](https://markdown.com.cn/basic/blockquotes)
61-
- [列表 | Lists](https://markdown.com.cn/basic/lists)
62-
- [代码 | Code](https://markdown.com.cn/basic/code)
63-
- [链接 | Links](https://markdown.com.cn/basic/links)
64-
- [图片 | Images](https://markdown.com.cn/basic/images)
65-
- [转义字符 | Escaping Characters](https://markdown.com.cn/basic/escaping-characters)
66-
67-
### 扩展语法 | Extended Syntax
68-
69-
- [表格 | Tables](https://markdown.com.cn/extended/tables)
70-
- [代码块 | Fenced Code Blocks](https://markdown.com.cn/extended/fenced-code-blocks)
71-
- [任务列表 | Task Lists](https://markdown.com.cn/extended/task-lists)
72-
- [删除线 | Strikethrough](https://markdown.com.cn/extended/strikethrough)
73-
74-
## License
75-
76-
MIT
3+
[中文版](./README_zh.md) | [English](./README_en.md)

‎README_en.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Markdown Tutorial
2+
3+
A comprehensive Markdown tutorial with bilingual support.
4+
5+
[View Online Tutorial](https://albert-lsk.github.io/Markdown-Tutorial/)
6+
7+
## Features
8+
9+
- :art: **Claude Design** — Anthropic's official design system
10+
- 🌙 **Dark Mode** — System-aware or manual toggle
11+
- 🇨🇳🇺🇸 **Bilingual** — Switch between Chinese and English
12+
- 💬 **Comments** — Giscus powered by GitHub Discussions
13+
14+
## Tech Stack
15+
16+
- **Framework**: [Astro](https://astro.build)
17+
- **Styling**: [Tailwind CSS](https://tailwindcss.com)
18+
- **Design**: Claude (Anthropic)
19+
20+
## Getting Started
21+
22+
```bash
23+
# Install dependencies
24+
npm install
25+
26+
# Start dev server
27+
npm run dev
28+
29+
# Build for production
30+
npm run build
31+
```
32+
33+
## Project Structure
34+
35+
```
36+
src/
37+
├── pages/
38+
│ ├── index.astro # Chinese homepage
39+
│ ├── en/ # English pages
40+
│ ├── basic/ # Basic syntax
41+
│ └── extended/ # Extended syntax
42+
├── components/ # Components
43+
├── layouts/ # Layouts
44+
├── styles/ # Styles
45+
└── i18n/ # Internationalization
46+
```
47+
48+
## Content
49+
50+
### Basic Syntax
51+
52+
- [Headings](https://albert-lsk.github.io/Markdown-Tutorial/en/basic/headings)
53+
- [Paragraphs](https://albert-lsk.github.io/Markdown-Tutorial/en/basic/paragraphs)
54+
- [Line Breaks](https://albert-lsk.github.io/Markdown-Tutorial/en/basic/line-breaks)
55+
- [Emphasis](https://albert-lsk.github.io/Markdown-Tutorial/en/basic/emphasis)
56+
- [Blockquotes](https://albert-lsk.github.io/Markdown-Tutorial/en/basic/blockquotes)
57+
- [Lists](https://albert-lsk.github.io/Markdown-Tutorial/en/basic/lists)
58+
- [Code](https://albert-lsk.github.io/Markdown-Tutorial/en/basic/code)
59+
- [Links](https://albert-lsk.github.io/Markdown-Tutorial/en/basic/links)
60+
- [Images](https://albert-lsk.github.io/Markdown-Tutorial/en/basic/images)
61+
- [Escaping Characters](https://albert-lsk.github.io/Markdown-Tutorial/en/basic/escaping-characters)
62+
63+
### Extended Syntax
64+
65+
- [Tables](https://albert-lsk.github.io/Markdown-Tutorial/en/extended/tables)
66+
- [Fenced Code Blocks](https://albert-lsk.github.io/Markdown-Tutorial/en/extended/fenced-code-blocks)
67+
- [Task Lists](https://albert-lsk.github.io/Markdown-Tutorial/en/extended/task-lists)
68+
- [Strikethrough](https://albert-lsk.github.io/Markdown-Tutorial/en/extended/strikethrough)
69+
70+
## License
71+
72+
MIT

‎README_zh.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Markdown 教程
2+
3+
Markdown 中文教程，完整指南。
4+
5+
[查看在线教程](https://albert-lsk.github.io/Markdown-Tutorial/)
6+
7+
## 特性
8+
9+
- :art: **Claude 设计风格** — 采用 Anthropic 官方设计系统
10+
- 🌙 **深色模式** — 自动跟随系统或手动切换
11+
- 🇨🇳🇺🇸 **中英双语** — 随时切换语言
12+
- 💬 **评论系统** — 基于 GitHub Discussions 的 Giscus 评论
13+
14+
## 技术栈
15+
16+
- **框架**: [Astro](https://astro.build)
17+
- **样式**: [Tailwind CSS](https://tailwindcss.com)
18+
- **设计**: Claude (Anthropic)
19+
20+
## 开始使用
21+
22+
```bash
23+
# 安装依赖
24+
npm install
25+
26+
# 启动开发服务器
27+
npm run dev
28+
29+
# 构建生产版本
30+
npm run build
31+
```
32+
33+
## 项目结构
34+
35+
```
36+
src/
37+
├── pages/
38+
│ ├── index.astro # 中文首页
39+
│ ├── en/ # 英文页面
40+
│ ├── basic/ # 基础语法
41+
│ └── extended/ # 扩展语法
42+
├── components/ # 组件
43+
├── layouts/ # 布局
44+
├── styles/ # 样式
45+
└── i18n/ # 国际化
46+
```
47+
48+
## 内容目录
49+
50+
### 基础语法
51+
52+
- [标题](https://albert-lsk.github.io/Markdown-Tutorial/basic/headings)
53+
- [段落](https://albert-lsk.github.io/Markdown-Tutorial/basic/paragraphs)
54+
- [换行](https://albert-lsk.github.io/Markdown-Tutorial/basic/line-breaks)
55+
- [强调](https://albert-lsk.github.io/Markdown-Tutorial/basic/emphasis)
56+
- [引用](https://albert-lsk.github.io/Markdown-Tutorial/basic/blockquotes)
57+
- [列表](https://albert-lsk.github.io/Markdown-Tutorial/basic/lists)
58+
- [代码](https://albert-lsk.github.io/Markdown-Tutorial/basic/code)
59+
- [链接](https://albert-lsk.github.io/Markdown-Tutorial/basic/links)
60+
- [图片](https://albert-lsk.github.io/Markdown-Tutorial/basic/images)
61+
- [转义字符](https://albert-lsk.github.io/Markdown-Tutorial/basic/escaping-characters)
62+
63+
### 扩展语法
64+
65+
- [表格](https://albert-lsk.github.io/Markdown-Tutorial/extended/tables)
66+
- [代码块](https://albert-lsk.github.io/Markdown-Tutorial/extended/fenced-code-blocks)
67+
- [任务列表](https://albert-lsk.github.io/Markdown-Tutorial/extended/task-lists)
68+
- [删除线](https://albert-lsk.github.io/Markdown-Tutorial/extended/strikethrough)
69+
70+
## License
71+
72+
MIT

0 commit comments

Comments
 (0)