File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1- # Markdown 教程 / Markdown Tutorial
1+ # Markdown 教程
22
3- [ 中文版] ( ./README_zh.md ) | [ English] ( ./README_en.md )
3+ [ English] ( ./README_en.md )
4+
5+ 面向真实工作流的 Markdown 教程站,重点不是背语法表,而是把 Markdown 真正用进 README、知识库、Issue、PR 和文档站。
6+
7+ [ 在线访问] ( https://albert-lsk.github.io/Markdown-Tutorial/ )
8+
9+ ## 这个项目现在是什么
10+
11+ - 中文优先的 Markdown 教程站
12+ - 支持中英双语切换
13+ - 提供亮色 / 暗色主题
14+ - 内容更偏真实写作场景,而不是通用语法罗列
15+
16+ ## 技术栈
17+
18+ - 框架: [ Astro] ( https://astro.build )
19+ - 样式: [ Tailwind CSS] ( https://tailwindcss.com )
20+ - 代码高亮与内容渲染: Astro 默认能力 + 自定义全局样式
21+
22+ ## 本地开发
23+
24+ ``` bash
25+ # 安装依赖
26+ npm install
27+
28+ # 启动开发服务器
29+ npm run dev
30+
31+ # 构建生产版本
32+ npm run build
33+ ```
34+
35+ ## 项目结构
36+
37+ ``` text
38+ src/
39+ ├── pages/
40+ │ ├── index.astro # 中文首页
41+ │ ├── intro.astro # 中文入门页
42+ │ ├── en/ # 英文页面
43+ │ ├── basic/ # 基础语法
44+ │ └── extended/ # 扩展语法
45+ ├── components/ # 公共组件
46+ ├── layouts/ # 页面布局
47+ ├── styles/ # 全局样式
48+ └── i18n/ # 国际化文案
49+ ```
50+
51+ ## 内容入口
52+
53+ ### 中文
54+
55+ - [ 首页] ( https://albert-lsk.github.io/Markdown-Tutorial/ )
56+ - [ 3 分钟上手] ( https://albert-lsk.github.io/Markdown-Tutorial/intro )
57+ - [ 基础语法] ( https://albert-lsk.github.io/Markdown-Tutorial/basic )
58+ - [ 扩展语法] ( https://albert-lsk.github.io/Markdown-Tutorial/extended )
59+ - [ 编辑器] ( https://albert-lsk.github.io/Markdown-Tutorial/editors )
60+
61+ ### English
62+
63+ - [ Home] ( https://albert-lsk.github.io/Markdown-Tutorial/en/ )
64+ - [ Intro] ( https://albert-lsk.github.io/Markdown-Tutorial/en/intro )
65+ - [ Basic Syntax] ( https://albert-lsk.github.io/Markdown-Tutorial/en/basic )
66+ - [ Extended Syntax] ( https://albert-lsk.github.io/Markdown-Tutorial/en/extended )
67+ - [ Editors] ( https://albert-lsk.github.io/Markdown-Tutorial/en/editors )
68+
69+ ## 当前内容方向
70+
71+ - 用更真实的示例讲 Markdown,比如 README、部署说明、发布记录和任务清单
72+ - 避免整站内容和常见 Markdown 教程站过于相似
73+ - 让亮色模式保持浅色体系,暗色模式保持深色体系
74+
75+ ## License
76+
77+ MIT
You can’t perform that action at this time.
0 commit comments