Skip to content

Commit c37508a

Browse files
committed
πŸ“ update website a bit
1 parent 23f4ddc commit c37508a

File tree

4 files changed

+25
-42
lines changed

4 files changed

+25
-42
lines changed

β€ŽREADME.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ This package provides utility functions and classes for make ESLint custom rules
1313
For examples:
1414

1515
- [getStaticValue](https://eslint-utils.mysticatea.dev/api/ast-utils.html#getstaticvalue) evaluates static value on AST.
16-
- [PatternMatcher](https://eslint-utils.mysticatea.dev/api/ast-utils.html#patternmatcher-class) finds a regular expression pattern as handling escape sequences.
1716
- [ReferenceTracker](https://eslint-utils.mysticatea.dev/api/scope-utils.html#referencetracker-class) checks the members of modules/globals as handling assignments and destructuring.
1817

1918
## πŸ“– Usage

β€Ždocs/.vuepress/config.js

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,12 @@ module.exports = {
1212
docsBranch: "master",
1313
editLinks: true,
1414

15-
nav: [
16-
{ text: "Guide", link: "/guide/getting-started" },
17-
{ text: "API Reference", link: "/api/ast-utils" },
18-
],
1915
sidebar: {
2016
"/": [
2117
{
2218
title: "Guide",
2319
collapsable: false,
24-
children: ["/guide/getting-started"],
20+
children: ["/"],
2521
},
2622
{
2723
title: "API Reference",

β€Ždocs/README.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,31 @@
1-
---
2-
home: true
3-
actionText: Get Started β†’
4-
actionLink: /guide/getting-started
5-
features:
6-
- title: Scope Utilities
7-
details: Finding the specific global variables and their members with tracking assignments, finding variables, etc...
8-
- title: AST Utilities
9-
details: Computing the runtime value of a node, Getting the property name of a Property|MemberExpression|MemberExpression node, etc...
10-
- title: Token Utilities
11-
details: Distinguishing the token types of a given token, etc...
12-
---
13-
14-
<center>
1+
# Getting Started
152

163
[![npm version](https://img.shields.io/npm/v/eslint-utils.svg)](https://www.npmjs.com/package/eslint-utils)
174
[![Downloads/month](https://img.shields.io/npm/dm/eslint-utils.svg)](http://www.npmtrends.com/eslint-utils)
185
[![Build Status](https://travis-ci.org/mysticatea/eslint-utils.svg?branch=master)](https://travis-ci.org/mysticatea/eslint-utils)
196
[![Coverage Status](https://codecov.io/gh/mysticatea/eslint-utils/branch/master/graph/badge.svg)](https://codecov.io/gh/mysticatea/eslint-utils)
207
[![Dependency Status](https://david-dm.org/mysticatea/eslint-utils.svg)](https://david-dm.org/mysticatea/eslint-utils)
218

22-
</center>
9+
## 🏁 Goal
10+
11+
`eslint-utils` package provides utility functions and classes for make ESLint custom rules.
12+
13+
## πŸ’Ώ Installation
14+
15+
Use [npm](https://www.npmjs.com/) or a compatible tool to install.
16+
17+
```
18+
npm install eslint-utils
19+
```
20+
21+
::: tip Requirements
22+
`eslint-utils` requires Node.js `6.5.0` or newer versions.
23+
:::
24+
25+
## πŸ“– Usage
26+
27+
```js
28+
const utils = require("eslint-utils")
29+
30+
// use it to define rules...
31+
```

β€Ždocs/guide/getting-started.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

0 commit comments

Comments
Β (0)