As a programmer, how to efficiently and accurately review documents is a necessary skill in daily development work.

For a long time, the official documents of good open source projects have been deployed on foreign servers, which are very slow to access from China, and some document servers are even not accessible at all due to well-known restrictions, which greatly restricts the access of Chinese developers to the first-hand official documents of open source projects.

To solve this problem, the Breword team wrote a crawler program that captures the document repository of open source projects stored on Github and then deploys it to the domestic server. At the same time, it automatically detects whether the original repository is updated every night and synchronizes the latest document content in case of update.

We recently crawled out the official documentation for ESLint and rushed to share it with you:

Document address: docs.breword.com/eslint-esli…

Features:

In order to improve the efficiency of reviewing documents, Breword provides the following features for all document sites, which I hope will help you.

  1. Document site search 🔍

    Breword builds a small, concise search engine into each document site, and generates an indexed list of all page content to enable instantaneous search experience on the client side:

  2. The same document directory as the source official document is 📖

    The document table of contents is arguably the most useful feature if you want to see everything in a document.

    Breword sorted out the document catalogs according to the project’s official documentation site catalogs and made them consistent with the official documentation site catalogs:

  3. Support mobile browser 📱

    Each document site is optimized for mobile rendering to ensure a great browsing experience on mobile as well:

  4. High appearance level, no annoying ads 😡

    Concise and beautiful page layout, beautiful fonts, Breword is committed to provide developers with a pleasant document browsing experience.

Finally, the documentation address for ESLint is docs.breword.com/eslint-esli…