/js-index

:capital_abcd: The index of everything about JavaScript

Primary LanguageHTML

简体中文

Build Status

JS Index

The index of everything about JavaScript

I'll update one item per day. Welcome to open an issue or create a pull request.

Why to create this index

Because JavaScript is being more and more popular, the related concepts is growing every day.

As for me, it's impossible to understand the whole world of JavaScript, but it's normally to hear some related concepts.

So I hope to collect every JavaScript concepts, in order to help people who need it, especially friends new to JavaScript.

Three principles

  1. Collecting every concepts, no matter how basic or how deep it is
  2. The description of each concept needs to be as simple as it can. It's ok to let our reader have a basic understanding for it, then additionally provide extra links for depth understanding
  3. The links we provided need to be as authority and meaningful as it can. Quality is better than quantity. Links is the most valuable thing in JS Index

Writing specifications

  1. Every files need to be named with lowercased letters and -, no spaces. In some special cases, it's allowed to use _, i.e. __proto__.md
  2. Second level heading need to be used for multiple meanings of one concept. In the other words, if one concept has only one meaning, but we need to use sub heading, then use third level heading instead
  3. Use unified words for proper nouns, for example, use JavaScript, not javascript or Javascript

TODOs

  • Use hexo to build the site
  • Apply for the domain name
  • Index concepts

JS Index

有关 JavaScript 的一切的索引

我会坚持每天更新一条。也欢迎提交 issue 或 pr。

为什么要创建这个索引

由于 JavaScript 正变得越来越流行,相关的概念也越来越多。

我认为,一个人是无法掌握 JavaScript 整个世界的,但是却会经常听到一些相关的概念。

所以我希望能够把 JavaScript 的所有概念都搜集起来,方便大家(特别是刚入门的朋友)查阅。

三个原则

  1. 搜集所有概念,不管它有多么基础或多么深奥
  2. 每个概念的描述尽可能简单明了,只需要让读者有个大致的理解即可。提供相关链接帮助读者深入理解
  3. 提供的相关链接尽可能权威,有意义,而不要堆积数量。相关链接是 JS Index 中最有价值的地方

书写规范

  1. 所有文件必须使用小写字母和 - 命名,如果是中文概念,则使用全拼命名,不能出现空格。特殊情况可以出现 _,比如 __proto__.md
  2. 中文排版遵循这个规范:写给大家看的中文排版指南
  3. 二级标题用于区分一个概念的多种含义,不能用于其他用途。换句话说,如果一个概念只有一种含义,但是需要子标题,则需要直接使用三级标题
  4. 当涉及到专有名词的时候,需要使用统一的词语。比如应该是 JavaScript 而不是 javascript 或 Javascript