Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/strdr4605/jump2header
Add "jump to" links for markdown headers
https://github.com/strdr4605/jump2header
hacktoberfest
Last synced: 10 days ago
JSON representation
Add "jump to" links for markdown headers
- Host: GitHub
- URL: https://github.com/strdr4605/jump2header
- Owner: strdr4605
- License: mit
- Created: 2020-03-29T22:13:55.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-13T16:13:46.000Z (about 4 years ago)
- Last Synced: 2024-11-21T14:40:24.327Z (about 1 month ago)
- Topics: hacktoberfest
- Language: TypeScript
- Homepage: https://www.npm.im/@strdr4605/jump2header
- Size: 74.2 KB
- Stars: 7
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jump2header#️⃣
[](https://coveralls.io/github/strdr4605/jump2header?branch=master)
[](http://makeapullrequest.com)
[](https://github.com/semantic-release/semantic-release)
Add "jump to" links for markdown headers
## Motivation[⬆](#jump2header️⃣)
When README is too long and it takes to much time to scroll back it is better to have a link back to top
```md
# awesome-project
...
Really long README
...
## Some section[⬆️](#awesome-project)
...
### Another section[⬆️](#awesome-project)
```
## Installation[⬆](#jump2header️⃣)
```bash
npm i -g @strdr4605/jump2header
```
## Usage[⬆](#jump2header️⃣)
```bash
jump2header # By default README.md file will be parsed and overwritten
```
## API[⬆](#jump2header️⃣)
```bash
jump2header --help
Options:
--help Show help [boolean]
--version Show version number [boolean]
--file, -f File to be parsed
Note: file shoud have .md extension
[string] [default: "README.md"]
--output, -o File to write new content
Note: input file will be overwritten if not provided
[string]
--slug, -s, --header, -h Specify header slug to jump to.
Note: use text after "#" in url.
https://github.com//#api -> api
[string]
--position, -p Specify position of the link
"header" -> Link will be in header
"start" -> Link will be at the start of the section
"end" -> Link will be at the end of the section
Caution: may be some bugs with "end"
[choices: "header", "start", "end"] [default: "header"]
--text, -t Specify text that will be used instead of emoji
Note: multiple words should be wrapped in quotes ""
[string]
--start Specify header from where to start adding links.
Notes:
multiple words should be wrapped in quotes ""
will much by RegExp
[string]
--end Specify header to where to end adding links.
Notes:
multiple words should be wrapped in quotes ""
will much by RegExp
[string]
--maxLevel, -l, --max-level Specify maximal header level to insert links.
Note: value between 1 and 6
[number] [choices: 1, 2, 3, 4, 5, 6] [default: 6]
--emoji, -e Specify the emoji for the links.
1 -> ⬆
2 -> 🔝
3 -> 🔙
4 -> 🆙
5 -> 🔼
[number] [choices: 1, 2, 3, 4, 5] [default: 1]
--silent By default jump2header will add comment to created
links.
Use this flag if you don't want the comment
[boolean]
```
## Examples[⬆](#jump2header️⃣)
- [basic](examples/basic.md)
- [jump2SpecificSlug](examples/jump2SpecificSlug.md)
- [maxHeaderLevel](examples/maxHeaderLevel.md)
- [Emoji choice](examples/emojiChoice.md)
- [Start and end](examples/startEnd.md)
- [Change link position](examples/position.md)
- [Custom text](examples/text.md)
## TODO[⬆](#jump2header️⃣)
This tool is in the early stages and is not fully covered with unit/e2e tests. So if you have time and know how to write tests for this tool please contribute with PRs or links on that may be helpful. See [#18](https://github.com/strdr4605/jump2header/issues/18).
## Development[⬆](#jump2header️⃣)
```bash
npm i
npm run build:watch
```
In another tab
```bash
npm link
jump2header --help # or any other options
npm unlink # unlink after finishing work
```
