mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-08 14:47:12 +02:00
21 lines
607 B
JavaScript
21 lines
607 B
JavaScript
/**
|
|
* Copyright (c) 2017-present, Facebook, Inc.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
const GitHubSlugger = require('github-slugger');
|
|
|
|
/**
|
|
* Converts a string to a slug, that can be used in heading anchors
|
|
*
|
|
* @param {string} string
|
|
* @param {() => string} [slugger] - reused slugger to track used slugs and
|
|
* ensure that new slug will be unique
|
|
*
|
|
* @return {string}
|
|
*/
|
|
module.exports = (string, slugger = new GitHubSlugger()) => {
|
|
return slugger.slug(string);
|
|
};
|