文件结构规范说明

根目录文件

README.md

• 位置: 根目录
• 格式: Markdown
• 用途: 项目首页和说明文档

.gitignore

• 位置: 根目录
• 用途: 指定 Git 忽略跟踪的文件和文件夹

.gitattributes

• 位置: 根目录
• 用途: 配合 Git LFS 管理大文件

index.html

• 位置: 根目录
• 用途: 项目默认入口页面

---

文件夹结构

assets/

存放静态资源文件

assets/
├──styles/         # CSS 样式资源
│├──others/        # 其他样式资源
││├──css/        # 其他样式资源css文件
│││└──详细文件
││└──js/        # 其他样式资源js文件
││ └──详细文件
│└──pages/        # 页面样式资源
│ ├──css/        # 页面样式资源css文件
│ │└──详细文件
│ └──js/        # 页面样式资源js文件
│  └──详细文件
├──fonts/         # 字体资源
│├──chinese/        # 中文字体资源
││└──详细文件
│└──japanese/        # 日文字体资源
│ └──详细文件
├──images/         # 图片文件
│├── ico/        # .ico 格式图标
││└──详细文件
│├── jpg/        # .jpg 格式图片
││└──详细文件
│└── png/        # .png 格式图片
│ └──详细文件
├──audios/        # 音频文件
│└──mp3/        # .mp3 格式音频文件
│ └──详细文件
└──videos/        # 视频文件
 └──mp4/        # .mp4 格式视频文件
  └──详细文件

docs/

存放项目规范和文档

docs/
├── images/          # 文档用到的图片文件
├── copyright-notice.md          # 项目版权声明文档
├── structure-guide.md          # 文件结构规范文档
└── naming-convention.md          # 命名规范文档

pages/

存放所有页面文件

pages/
├──html/        # 一般HTML页面资源
│├──docs/        # 文档页面资源
││└──详细文件
│├──root-directory/        # 根目录页面资源
││└──详细文件
│├──troubleshooting/        # 疑难解答页面资源
││└──详细文件
│└──其它文件
└──mini-project/        # 非独立仓库或者暂时的完整小项目文件
    └──详细文件

troubleshooting/

存放疑难解答文档

├──macos-terminal-grammar.md        # macOS终端语法文档
└──markdown-grammar.md        # markdown语法文档

---

使用说明

1. 所有路径均从根目录开始计算
2. 文件命名使用英文符号,避免兼容性问题
3. 各文件夹按功能明确分类,便于维护

本规范会根据项目发展适时更新。