文档规范

项目文档建议使用vitepress进行编写。

文案风格

• 一定多检查，确保没有错别字。
• 即使是流行语中的谐音错别字也不要使用，比如「墙裂」、「童鞋」等。
• 请在检查中把对表达意思没有明显作用的字、词、句删除，在不影响表达效果的前提下把文案长度减到最短
• 如果你写了一条文案觉得非常聪明非常好笑，很可能需要停下来想一下用户是否能理解。
• 注意特殊名词的大小写：Android、iOS、iPhone、Google、Apple，无论是否在句首都应该以同样的方式写（有 lint 工具限制）。
• 只有中文或中英文混排中，一律使用中文/全角标点。

文档格式

严格遵循markdownlint格式。

特殊名词大小写

  'JavaScript',
  'HTML',
  'CSS',
  'AJAX',
  'JSON',
  'DOM',
  'BOM',
  'Less',
  'Sass',
  'SCSS',
  'HTTP',
  'HTTPS',
  'WebSocket',
  'ECMAScript',
  'ECMAScript 2015',
  'ECMAScript 6',
  'ES6',
  'ES2015',
  'jQuery',
  'jQuery Mobile',
  'React',
  'React Native',
  'Bootstrap',
  'Gulp',
  'Grunt',
  'webpack',
  'Yeoman',
  'npm',
  'spm',
  'Babel',
  'Mocha',
  'Jasmine',
  'PHP',
  'Java',
  'Node.js',
  'NodeJS',
  'MySQL',
  'MongoDB',
  'Redis',
  'Apache',
  'Nginx',
  'NGINX',
  'GitHub',
  'GitLab',
  'GitCafe',
  'Chrome',
  'Firefox',
  'Safari',
  'Internet Explore',
  'IE',
  'IE 7',
  'Opera',
  'UC',
  'Android',
  'iOS',
  'Windows',
  'OS X',
  'Ubuntu',
  'Linux',
  'Debian',
  'PC',
  'Mobile',
  'H5',
  'MacBook',
  'MacBook Pro',
  'MacBook Air',
  'iMac',
  'Mac Pro',
  'iPad',
  'Mac mini',
  'iPad Air',
  'iPad Air 2',
  'iPad mini',
  'iPhone',
  'iPhone 6s',
  'iPhone 6s Plus',
  'Apple Watch',
  'Google',
  'Alphabet',
  'Apple',
  'Microsoft',
  'Yahoo',
  'FPS',
  'UI',
  'URL',
  'URI',
  'URLs',
  'URIs',
  'Visual Studio Code';