中文     English

目录

• 👀 项目背景
• 🤳 使用
• 🧩 项目结构
• 📫 问题与评论
• 👨‍💻 贡献
• 💪 支持
• 🔑 License

​

👀 项目背景

万丈高楼平地起，盘龙卧虎高山齐。前端技术日新月异，开发框架更是如雨后春笋般大量涌现。但无论技术如何发展，框架如何更新，万变不离其中，终究不过是HTML、JS、CSS的封装与变换。

我认为能否学好Web开发的关键在于是否学好与学懂HTML、JS、CSS三大基础语言。

本项目则是介绍三大基础语言之一HTML的网站（待本项目更新完成则会相继出CSS与JS的指南），目前市面上各类学习HTML网站如此之多，为什么还选择自己造轮子呢？原因在于我学习HTML时发现各类网站存在如下问题：

• 知识点较为分散，想要全面且统一的了解与学习HTML需要看很多不同的网站
• 各种网站的操作又较为复杂，各种跳转与广告让人思绪混乱
• 知识点介绍生硬，让人难以理解

因此我就萌生了要自己做一个介绍HTML的网站，它能全面且统一、生动且形象的介绍HTML，它不会广告满天飞，布局结构干净整洁，能够快速且准确给您想要的答案！于是乎该项目——《HTML指南》便诞生了！

​

🤳 使用

为给大家带来不一样的感受，我们使用了一些技术手段以及满足了PWA的所有特性，它会给您带来意想不到的体验！！！

😀🤩😍🥳

​

⚙️ 可安装 ⚙️

PC可通过浏览器导航栏右上角安装图标将网页安装到桌面，移动设备可通过浏览器将网页添加到主屏幕，这样您就可获得应用级的体验

​

❌ 可离线访问 ❌

当您将网页添加到桌面，您就可获得应用级的体验，这包括了即使在没有网络的情况下，您依然可以正常访问网页阅读文档

​

📍 记录阅读位置 📍

当您退出网页再次进入时，点击'返回之前位置'即可回到上次阅读的位置

🧩 项目结构

├── .github/workflows                     # github action 配置文件存放目录
|    ├── deploy.yml                       # github pages 自动部署
|    ├── deploy(domestic).yml             # 国内站点自动部署
|    └── generate-readme-file.yml         # readme相关资源文件自动生成
├── docs                                  # 网站内容存放目录
|    ├── .vuepress                        # 用于存放vuepress全局的配置、组件、静态资源等
|    |    ├── components                  # 存放Vue组件目录
|    |    |    └── ......                 # 一些Vue组件
|    |    ├── public                      # 静态资源存放目录
|    |    |    ├── manifest.json          # PWA manifest配置文件
|    |    |    └── ......                 # png/svg...等资源文件
|    |    ├── styles                      # 样式文件存放目录
|    |    |    └── palette.styl           # 用于重写默认颜色常量
|    |    ├── config.js                   # 配置文件的入口文件
|    |    └── enhanceApp.js               # 客户端应用的增强配置
|    ├── content                          # 用于存放各类md文档(中文)
|    |    ├── xxxx.md                     # 各类md文档
|    |    └── .......                     
|    ├── en                               # 用于存放英文页面
|    |    ├── content                     # 用于存放各类md文档(英文)
|    |    |    ├── xxxx.md                # 各类md文档
|    |    |    └── .......                
|    |    ├── comment.md                  # 评论页面(英文)
|    |    ├── README.md                   # 站点首页(英文)
|    |    ├── support.md                  # 支持页面(英文)
|    |    └── usage.md                    # 使用说明页面(英文)
|    ├── comment.md                       # 评论页面(中文)
|    ├── README.md                        # 站点首页(中文)
|    ├── support.md                       # 支持页面(中文)
|    └── usage.md                         # 使用说明页面(中文)
├── resource                              # 存放readme中的静态资源
├── .gitignore                            # github忽略文件
├── LICENSE                               # license
├── README(EN).md                         # readme英文
├── README.md                             # readme
├── _config.yml                           # github page配置页面
├── deploy.sh                             # 部署国内站点修改文件脚本
└── package.json                          # npm配置文件

📫 问题与评论

遇到问题怎么办？

如果您在使用中遇到问题，请您先搜索issues中是否有您的问题的答案，如果未能找到答案，请您在issues中提交您遇到的问题，我们会及时处理。

怎么发表您的看法与建议？

如果您想发表自己的看法与建议，您可以前往discussions或者issues中的评论中发表，当然您也可以直接前往站点的评论区(国内)发表

👨‍💻 贡献

如果您发现了项目bug或者有兴趣为该项目做出贡献，请您遵循以下规则：

• 本项目由vuepress构造，需要您具备基于vuepress的开发能力
• 仔细阅读🧩项目结构以及相关的项目代码，确保您已足够了解项目
• 如果是项目bug请提交一个issue，在提交 issue 之前，请搜索相关内容是否已被提出
• 请先 fork 一份到自己的项目下，不要直接在仓库下建分支。
• commit 信息请描写准确，并且必须关联相关的issue
• 确保 PR 是提交到 main 分支，而不是 dev或其他 分支

海内存知己，天涯若比邻。感谢大家的贡献!!!

💪 支持

赠汪伦

李白

李白乘舟将欲行，忽闻岸上踏歌声。

桃花潭水深千尺，不及汪伦送我情。

如若您觉得项目不错可以给项目一个star✨,并在评论中发表您的想法✍。当然您如果比较宽裕的话，可以请作者喝一杯咖啡🍵

支付宝	微信

🔑 License

MIT