https://github.com/eslint/eslint.org

ESLint website
https://github.com/eslint/eslint.org

Last synced: 16 days ago
JSON representation

ESLint website

• Host: GitHub
• URL: https://github.com/eslint/eslint.org
• Owner: eslint
• License: apache-2.0
• Created: 2021-10-26T18:17:57.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-13T16:18:51.000Z (3 months ago)
• Last Synced: 2024-04-14T01:50:06.198Z (2 months ago)
• Language: JavaScript
• Size: 42.3 MB
• Stars: 67
• Watchers: 13
• Forks: 50
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• my-awesome-stars - eslint/eslint.org - ESLint website (JavaScript)

README

        
# The New eslint.org

This repository contains the source code for the ESLint website ().

## Developer Setup

In order to run the website, you must have [Node.js](https://nodejs.org) installed.

1. Create a fork of the repository

2. Run `npm install`

3. Run `npm run install:playground`

To start a local copy of the website, run:

```shell

npm start

```

To start a local copy of a foreign language website, specify the `ESLINT_SITE_NAME` environment variable equal to the name of the site, such as:

```shell

ESLINT_SITE_NAME=es npm start

```

## Translations

If you'd like to add a new translation of this website, please [open an issue](https://github.com/eslint/eslint.org/issues/new/choose) first.

In order to create a new translation:

1. Copy the `src/_data/sites/en.yml` file to a new site file in the same directory. The filename should be the language code of the language you want to translate into. For example, if you want to translate into Spanish, you should create the file `src/_data/sites/es.yml` because "es" in the Spanish language code.

2. Translate the text in the new site file to your chosen language.

3. Test it locally to ensure that it works properly using the instructions in the previous section.

4. Submit your pull request

The ESLint team will create a new domain name, set up analytics and ads, and otherwise prepare the website for deployment.

## License

[Apache 2.0](LICENSE)