Skip to content

README(EN).md

Latest commit

 

History

History
219 lines (145 loc) · 11 KB

README(EN).md

File metadata and controls

219 lines (145 loc) · 11 KB

中文     English

Table of Contents

👀 Background

Front-end technologies are changing with each passing day, and development frameworks have sprung up like mushrooms after a rain. But no matter how the technology develops or how the framework is updated, All changes are nothing more than the encapsulation and transformation of HTML, JS, and CSS

I think the key to learning web development well is whether you can learn well and understand the three basic languages ​​​​of HTML, JS, and CSS.。

This project is a website that introduces HTML, one of the three basic languages (the CSS and JS guides will be published after the project is updated). There are so many HTML learning websites on the market, why do you choose to build your own wheels? The reason is that when I was learning HTML, I found that various websites have the following problems:

  • The knowledge points are scattered. If you want to understand and learn HTML comprehensively and uniformly, you need to see many different websites.
  • The operation of various websites is more complicated, and various jumps and advertisements make people confused
  • The introduction of knowledge points is blunt and difficult to understand
Therefore, I came up with the idea of making a website that introduces HTML by myself. It can introduce HTML comprehensively, uniformly, vividly and vividly. It will not be full of advertisements, and the layout structure is clean and tidy, and it can give you the answers you want quickly and accurately! And so the project - 《The HTML Guide》 was born!

🤳 Usage

In order to bring you a different feeling, we have used some technical means and satisfied all the characteristics of PWA, which will bring you an unexpected experience! ! !

😀🤩😍🥳

​

⚙️ Installable ⚙️

PC can install web pages to the desktop through the install icon in the upper right corner of the browser's navigation bar, and mobile devices can add web pages to the home screen through the browser, so you can get an app-level experience

​

❌ Offline Access ❌

When you add a web page to your desktop, you get an app-level experience, including the ability to access web pages and read documents even without a network

​

📍 Record Reading Position 📍

When you exit the web page and enter again, click 'Return to previous position' to return to the last reading position

​

🧩 Project Structure

├── .github/workflows                  # github action Configuration file storage directory
|    ├── deploy.yml                    # github pages Automatic deployment
|    ├── deploy(domestic).yml          # automatic deployment of domestic sites
|    └── generate-readme-file.yml      # readme relevant resource files are automatically generated
├── docs                               # website content storage directory
|    ├── .vuepress                     # used to store vuepress global configuration, components, static     |    |    |                              resources, etc.
|    |    ├── components               # store Vue component directory
|    |    |    └── ......              # some Vue components
|    |    ├── public                   # static resource storage directory
|    |    |    ├── manifest.json       # PWA manifest configuration file
|    |    |    └── ......              # png/svg...resource files
|    |    ├── styles                   # style file storage directory
|    |    |    └── palette.styl        # used to override default color constants
|    |    ├── config.js                # entry file for configuration file
|    |    └── enhanceApp.js            # enhanced configuration for client applications
|    ├── content                       # store various md documents (Chinese)
|    |    ├── xxxx.md                  # various md documents
|    |    └── .......                     
|    ├── en                            # store English pages
|    |    ├── content                  # store various md documents (English)
|    |    |    ├── xxxx.md             # various md documents
|    |    |    └── .......                
|    |    ├── comment.md               # comments page (English)
|    |    ├── README.md                # site Home (English)
|    |    ├── support.md               # support page (English)
|    |    └── usage.md                 # instructions page (English)
|    ├── comment.md                    # comments page (Chinese)
|    ├── README.md                     # site home (Chinese)
|    ├── support.md                    # support page (Chinese)
|    └── usage.md                      # instructions page (Chinese)
├── resource                           # store static resources in readme
├── .gitignore                         # github ignore files
├── LICENSE                            # license
├── README(EN).md                      # readme
├── README.md                          # readme
├── _config.yml                        # github page configuration file
├── deploy.sh                          # deploy domestic site modification file script
└── package.json                       # npm configuration file

Issue And Comment

What should I do if I encounter a problem?

If you encounter problems during use, please search issues to see if there is an answer to your question. If you cannot find an answer, please Submit your issues in issues and we will deal with them in time.

How to express your views and suggestions?

If you want to post your own opinions and suggestions, you can go to discussions or comments in issues , of course you can also go directly to the comment in site (domestic) published

👨‍💻 Contributing

If you find a project bug or are interested in contributing to the project ingredients, please follow these rules:

  • This project is constructed by vuepress and requires your ability to develop based on vuepress
  • Read 🧩 Project Structure and related project code carefully to make sure you know enough about the project
  • If it is a project bug, please submit an issue, before submitting an issue, please search whether the relevant content has been raised
  • Please fork to your own project first, do not create a branch directly under the repository.
  • Please describe the commit information accurately and related issue
  • PRs are committed to the main branch, not the dev or other branch

The sea has confidants in memory, and the ends of the earth are like neighbors. Thanks for everyone's contributions!!!

💪 Support

赠汪伦

李白

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

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

If you think the project is good, you can give the project a star✨, and post your thoughts in comment✍. Of course, if you are well-off, you can invite the author to drink a cup of coffee🍵

Alipay WeChat Pay

🔑 License

MIT