yujiangshui/structure-the-javascript-api repository overview

⁠structure

// This project is in development.

Put everything you need to know of JavaScript in a structural way.

⁠Contribution

⁠Format Description

⁠Meta File

The meta.md file used to represent the Detail's meta information, such as:

• detail_id is a uuid, must unique in this project, used to identify this Detail.
• name represent this Detail's name or title.
• name[LOCALE] name in other languages.
• root only the root Detail (JavaScript) is true, others are false or undefined.
• order_in_siblings used to control the order manually.

⁠README[LOCALE] File

The README.md and README[LOCALE].md files contain the Detail's content, such as:

• Title (required) the first H1 is the title of this Detail.
• Intro the content between the first H1 and specified H2 titles will be parsed as short introduction automatically.
• Demo used to demonstrate this Detail, can be HTML string (iframe), usually use CodeSandbox⁠.
• Resources list-only content, list many useful articles, videos, course, etc.
• Specifications list-only content, link to the official specifications page.
• Codes list-only content, link to the source code which related to this Detail's content.
• Interview Questions list many common interview questions related to this Detail's content. And the question must be an H3 and start with Q:, and the content between two Q: will become the answer to the above question.

You must use the specified title to represent each section, even in the others language README.md. The parser needs these specified titles to parse and divided the content into a different part.

• Demo for the demostration section.
• Specifications for the specifications section.
• Resources for the resources section.
• Codes for the codes section.
• Interview Questions for the interview questions section.

list-only content means you can just put one list and each item is a link ([title](link) format) in this section, that's because we don't create contents, we just link to other good materials. And we need to keep these section simple.

Some links will have a Reading Time after the title, and you can use Chrome Extension Instant Reading Time⁠ to get the estimated time.