Gathering detailed insights and metrics for github-slugger
Gathering detailed insights and metrics for github-slugger
:octocat: Generate a slug just like GitHub does for markdown headings. Generate a slug just like GitHub does for markdown headings.
Installations
npm install github-sluggerDeveloper Guide
BETA
Typescript
Yes
Module System
ESM
Node Version
18.2.0
NPM Version
8.19.1
Releases
3
Languages
1
JavaScript
JavaScript (100%)
Developer
Flet
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
ISC License
377 Stars
78 Commits
34 Forks
5 Watchers
1 Branches
14 Contributors
Updated on Jul 08, 2025
Maintainers
5
Package Meta Information
Latest Version
2.0.0
Package Id
github-slugger@2.0.0
Unpacked Size
15.53 kB
Size
6.21 kB
File Count
7
NPM Version
8.19.1
Node Version
18.2.0
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
github-slugger
Generate a slug just like GitHub does for markdown headings. It also ensures slugs are unique in the same way GitHub does it. The overall goal of this package is to emulate the way GitHub handles generating markdown heading anchors as close as possible.
This project is not a markdown or HTML parser: passing alpha *bravo* charlie
or alpha <em>bravo</em> charlie doesn’t work.
Instead pass the plain text value of the heading: alpha bravo charlie.
Install
npm install github-slugger
Usage
1import GithubSlugger from 'github-slugger' 2 3const slugger = new GithubSlugger() 4 5slugger.slug('foo') 6// returns 'foo' 7 8slugger.slug('foo') 9// returns 'foo-1' 10 11slugger.slug('bar') 12// returns 'bar' 13 14slugger.slug('foo') 15// returns 'foo-2' 16 17slugger.slug('Привет non-latin 你好') 18// returns 'привет-non-latin-你好' 19 20slugger.slug('😄 emoji') 21// returns '-emoji' 22 23slugger.reset() 24 25slugger.slug('foo') 26// returns 'foo'
Check test/fixtures.json for more examples.
If you need, you can also use the underlying implementation which does not keep track of the previously slugged strings (not recommended):
1import GithubSlugger, {slug} from 'github-slugger' 2 3slug('foo bar baz') 4// returns 'foo-bar-baz' 5 6slug('foo bar baz') 7// returns the same slug 'foo-bar-baz' because it does not keep track
Contributing
Contributions welcome! Please read the contributing guidelines first.
License
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: ISC License: LICENSE:0
Reason
0 existing vulnerabilities detected
Reason
Found 5/29 approved changesets -- score normalized to 1
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/main.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/Flet/github-slugger/main.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/Flet/github-slugger/main.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/Flet/github-slugger/main.yml/master?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/main.yml:15
- Info: 0 out of 1 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 2 third-party GitHubAction dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 7 are checked with a SAST tool
Score
3.5
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More