Skip to content

示例项目

本目录包含了各种使用场景的示例项目,帮助你更好地理解和使用 Tiebo。

  • 位置: examples/basic-site/
  • 描述: 最简单的文档站点配置
  • 功能: 基本的页面组织和导航
  • 位置: examples/tech-blog/
  • 描述: 个人技术博客的完整实现
  • 功能: 文章分类、标签系统、评论功能
  • 位置: examples/api-docs/
  • 描述: RESTful API 的详细文档
  • 功能: 接口说明、代码示例、交互测试
  • 位置: examples/product-manual/
  • 描述: 软件产品的用户手册
  • 功能: 分步骤指南、截图说明、FAQ
  • 位置: examples/course/
  • 描述: 在线课程的文档站点
  • 功能: 课程大纲、进度跟踪、练习题

每个示例项目都包含:

  • README.md: 项目说明和运行指南
  • src/: 源代码目录
  • screenshots/: 效果截图
  • demo/: 在线演示链接

要运行示例项目:

Terminal window
# 进入示例目录
cd examples/[project-name]
# 安装依赖
npm install
# 启动开发服务器
npm run dev

欢迎提交你的示例项目!请遵循以下规范:

  1. 目录结构: 包含完整的源代码和说明文档
  2. 代码质量: 代码应该清晰、有良好的注释
  3. 文档完整: 包含详细的使用说明和效果展示
  4. 原创性: 确保示例内容的原创性和实用性

提交示例项目时,请创建 Pull Request 并简要说明项目的特点和使用场景。