js-tldr

Development

$ npm install
$ npm run dev

Contribution guide

Vision

We strive to provide noiseless experience for developers in order to let them stay focused on what they're doing at the moment

Goals

When developing the js-tldr we emphasize on the following requirements to every new feature or change:

• consistency
• minimalistic UX
• speed

Documentation guideline

Location

We write docs as markdown files which are public and can be accessed by the doc's URL, suffixed with .md. For example: https://js-tldr.info/docs/Array/concat - doc page https://js-tldr.info/docs/Array/concat.md - doc markdown sheet

Shape

Every doc meet the strict shape requirement. It should consist of the following parts:

• title
• short exhaustive description
• syntax - mandatory for methods, may be omitted for properties
• usage examples
• reference link

Doc skeleton example:

# Array.prototype.concat()

<description>

## Syntax

```js
<syntax definition>
```

## Usage examples

```js
<usage examples code>
```

---

[reference](link)

Description

In the description body:

• use bold + code markup for the name of the property or method - **`methodName`**
• do not use parentheses () with method name
• use code markup for syntax's terms and reflect them in syntax code example. For instance:

Code

In the syntax and usage examples code body:

• do not use abbreviations for variables names, eg DONT const str = ..., DO const string = ...
• use the stdout comment // -> to show results
• try to avoid using console.log, just use stdout comment and the end of method call or property expression