OpenAPI 项目教程

OpenAPI 项目教程

learn.openapis.orgOpenAPI - Getting started, and the specification explained项目地址:https://gitcode.com/gh_mirrors/le/learn.openapis.org

1. 项目的目录结构及介绍

learn.openapis.org/
├── _config.yml
├── _data
│   └── navigation.yml
├── _includes
│   ├── footer.html
│   ├── head.html
│   ├── header.html
│   └── sidebar.html
├── _layouts
│   ├── default.html
│   ├── home.html
│   └── page.html
├── _posts
│   └── 2021-01-01-welcome-to-jekyll.markdown
├── _sass
│   ├── minimal-mistakes
│   │   └── _reset.scss
│   └── main.scss
├── assets
│   ├── css
│   │   └── main.css
│   ├── images
│   │   └── logo.png
│   └── js
│       └── main.js
├──Gemfile
├──Gemfile.lock
├── index.md
├── about.md
└── README.md

• _config.yml: 项目的配置文件。
• _data/navigation.yml: 导航菜单的配置文件。
• _includes: 包含网站的头部、尾部、侧边栏等部分。
• _layouts: 网站的页面布局模板。
• _posts: 博客文章的存放目录。
• _sass: 样式表的SCSS文件。
• assets: 包含CSS、图片和JavaScript文件。
• Gemfile 和 Gemfile.lock: 项目依赖的Gem包配置文件。
• index.md: 首页内容。
• about.md: 关于页面内容。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件是 index.md，这是网站的首页内容。它通常包含项目的介绍、使用说明和导航链接。

3. 项目的配置文件介绍

项目的配置文件是 _config.yml，它包含了网站的全局配置信息，例如：

title: "OpenAPI 学习指南"
description: "OpenAPI 规范的学习和使用指南"
baseurl: ""
url: "https://learn.openapis.org"
markdown: kramdown
theme: just-the-docs

• title: 网站的标题。
• description: 网站的描述。
• baseurl: 网站的基本URL。
• url: 网站的完整URL。
• markdown: 使用的Markdown解析器。
• theme: 使用的主题。

这些配置项决定了网站的基本外观和行为。

learn.openapis.orgOpenAPI - Getting started, and the specification explained项目地址:https://gitcode.com/gh_mirrors/le/learn.openapis.org