<commit_before># GitHub Markdown Tabele of Contents

Chrome extension to show a table of contents on GitHub.  
No more scrolling to read long long long documents.

![this app on GitHub](doc/screenshot.png)  
*An example of a long readme with this extension -- AVA: a nice test runner for Node.js*

## Install
You can install the latest version manually.

1. Clone this repository.
2. Visit chrome://extensions.
3. Click to check *Developer mode*.
4. Click *Load unpacked extension...*.
5. Select the *dist* directory.

For more info, see [Chrome Extension Get Started](https://developer.chrome.com/extensions/getstarted#unpacked) or [Google Chrome FAQ](https://developer.chrome.com/extensions/faq#faq-dev-01).

## Usage
Click the button on the top right-hand corner to show or hide the table of contents.

## Permissions
This extension uses _https://github.com/*_, *contentSettings* and *tabs*.  
- _https://github.com/*_ is used to run scripts on GitHub.
- *contentSettings* and *tabs* are used to know whether JavaScript is enabled in the tab or not.

## Recommended environment
- the latest stable version of Google Chrome

## License
CC0  
[![CC0](https://licensebuttons.net/p/zero/1.0/88x31.png "CC0")](http://creativecommons.org/publicdomain/zero/1.0/)
<commit_msg>improve README<commit_after># GitHub Markdown Tabele of Contents

Chrome extension to show a table of contents on GitHub.  
No more scrolling to read long long long documents.

![this app on GitHub](doc/screenshot.png)  
*An example of a long readme with this extension -- AVA: a nice test runner for Node.js*

Works with:
- README on the top pages
- Markdown files
- Wikis
- Commented tags in release pages

## Install
You can install the latest version manually.

1. Clone this repository.
2. Visit chrome://extensions.
3. Click to check *Developer mode*.
4. Click *Load unpacked extension...*.
5. Select the *dist* directory.

For more info, see [Chrome Extension Get Started](https://developer.chrome.com/extensions/getstarted#unpacked) or [Google Chrome FAQ](https://developer.chrome.com/extensions/faq#faq-dev-01).

## Usage
Click the button on the top right-hand corner to show or hide the table of contents.

## Permissions
This extension uses _https://github.com/*_, *contentSettings* and *tabs*.  
- _https://github.com/*_ is used to run scripts on GitHub.
- *contentSettings* and *tabs* are used to know whether JavaScript is enabled in the tab or not.

## Recommended environment
- the latest stable version of Google Chrome

## License
CC0  
[![CC0](https://licensebuttons.net/p/zero/1.0/88x31.png "CC0")](http://creativecommons.org/publicdomain/zero/1.0/)

{'fraction_non_alphanumeric': 0.10715638015903067, 'fraction_numerical': 0.013631200302915562, 'mean_word_length': 4.0807692307692305, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 10, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1127617', 'n_tokens_mistral': 804, 'n_tokens_neox': 764, 'n_words': 316}