npmpackage.info

Gathering detailed insights and metrics for github-slugger

Other packages similar to github-slugger

@caldwell619/github-slugger

0.0.3

Fork of github-slugger written in TS

github-slugger-typescript

1.1.0

This project is a small Typescript fork of the [github-slugger](https://github.com/Flet/github-slugger) Javascript library from Dan Flettre.

@package-tucker/textlint-linkcheck-relative-ids

1.1.1

This is a textlint rule that validates relative links in markdown documents. First it verifies that relative links belong to a file, then it verifies the anchor in the link exists in a header id or by using the github-slugger.

rehype-slug

6.0.0

rehype plugin to add `id` attributes to headings

Gathering detailed insights and metrics for github-slugger

github-slugger

:octocat: Generate a slug just like GitHub does for markdown headings. Generate a slug just like GitHub does for markdown headings.

2.0.0

349

ISC

JavaScript

890,439,796 3.5

Installations

npm install github-slugger

Pull Requests

Open

0

Total

29

Closed

9

Merged

20

Issues

Open

0

Total

22

Closed

22

Releases

2.0.0

Published on 27 Oct 2022

v1.5.0

Published on 25 Oct 2022

v1.4.0

Published on 24 Aug 2021

View all 3 releases

Developer

Flet

Developer Guide

BETA

Module System

ESM

Min. Node Version

Typescript Support

Yes

Node Version

18.2.0

NPM Version

8.19.1 Statistics

349 Stars

78 Commits

33 Forks

6 Watching

1 Branches

14 Contributors

Updated on 27 Nov 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

890,439,796

Last day

-4.6%

1,192,793

Compared to previous day

Last week

1.3%

6,268,643

Compared to previous week

Last month

4.7%

27,423,208

Compared to previous month

Last year

24.9%

310,599,987

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@octokit/rest @types/regenerate @types/tape @unicode/unicode-13.0.0 c8 hast-util-select mdast-util-gfm mdast-util-to-markdown node-fetch regenerate rehype-parse rimraf standard tap-spec tape type-coverage typescript unified

Versions

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

ISC

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.5

/10

Last Scanned on 2024-11-25

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