Skip to content

Commit

Permalink
📝 update website a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
mysticatea committed Oct 21, 2019
1 parent 23f4ddc commit c37508a
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 42 deletions.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ This package provides utility functions and classes for make ESLint custom rules
For examples:

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

## 📖 Usage
Expand Down
6 changes: 1 addition & 5 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,12 @@ module.exports = {
docsBranch: "master",
editLinks: true,

nav: [
{ text: "Guide", link: "/guide/getting-started" },
{ text: "API Reference", link: "/api/ast-utils" },
],
sidebar: {
"/": [
{
title: "Guide",
collapsable: false,
children: ["/guide/getting-started"],
children: ["/"],
},
{
title: "API Reference",
Expand Down
39 changes: 24 additions & 15 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,31 @@
---
home: true
actionText: Get Started →
actionLink: /guide/getting-started
features:
- title: Scope Utilities
details: Finding the specific global variables and their members with tracking assignments, finding variables, etc...
- title: AST Utilities
details: Computing the runtime value of a node, Getting the property name of a Property|MemberExpression|MemberExpression node, etc...
- title: Token Utilities
details: Distinguishing the token types of a given token, etc...
---

<center>
# Getting Started

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

</center>
## 🏁 Goal

`eslint-utils` package provides utility functions and classes for make ESLint custom rules.

## 💿 Installation

Use [npm](https://www.npmjs.com/) or a compatible tool to install.

```
npm install eslint-utils
```

::: tip Requirements
`eslint-utils` requires Node.js `6.5.0` or newer versions.
:::

## 📖 Usage

```js
const utils = require("eslint-utils")

// use it to define rules...
```
21 changes: 0 additions & 21 deletions docs/guide/getting-started.md

This file was deleted.

0 comments on commit c37508a

Please sign in to comment.