mirror of
https://github.com/facebook/docusaurus.git
synced 2025-08-06 10:20:09 +02:00
db79d462ab
* POC of autogenerated sidebars
* use combine-promises utility lib
* autogenerated sidebar poc working
* Revert "autogenerated sidebar poc working"
This reverts commit c81da980
* POC of auto-generated sidebars for community docs
* update tests
* add initial test suite for autogenerated sidebars + fix some edge cases
* Improve autogen sidebars: strip more number prefixes in folder breadcrumb + slugs
* fix typo!
* Add tests for partially generated sidebars + fix edge cases + extract sidebar generation code
* Ability to read category metadatas file from a file in the category
* fix tests
* change position of API
* ability to extract number prefix
* stable system to enable position frontmatter
* fix tests for autogen sidebar position
* renamings
* restore community sidebars
* rename frontmatter position -> sidebar_position
* make sidebarItemsGenerator fn configurable
* minor changes
* rename dirPath => dirName
* Make the init template use autogenerated sidebars
* fix options
* fix docusaurus site: remove test docs
* add _category_ file to docs pathsToWatch
* add _category_ file to docs pathsToWatch
* tutorial: use sidebar_position instead of file number prefixes
* Adapt Docusaurus tutorial for autogenerated sidebars
* remove slug: /
* polish the homepage template
* rename _category_ sidebar_position to just "position"
* test for custom sidebarItemsGenerator fn
* fix category metadata + add link to report tutorial issues
* fix absolute path breaking tests
* fix absolute path breaking tests
* Add test for floating number sidebar_position
* add sidebarItemsGenerator unit tests
* add processSidebars unit tests
* Fix init template broken links
* windows test
* increase code translations test timeout
* cleanup mockCategoryMetadataFiles after windows test fixed
* update init template positions
* fix windows tests
* fix comment
* Add autogenerated sidebar items documentation + rewrite the full sidebars page doc
* add useful comment
* fix code block title
109 lines
3 KiB
TypeScript
109 lines
3 KiB
TypeScript
/**
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
import getSlug from '../slug';
|
|
|
|
describe('getSlug', () => {
|
|
test('should default to dirname/id', () => {
|
|
expect(getSlug({baseID: 'doc', dirName: '/dir'})).toEqual('/dir/doc');
|
|
expect(getSlug({baseID: 'doc', dirName: '/dir/subdir'})).toEqual(
|
|
'/dir/subdir/doc',
|
|
);
|
|
});
|
|
|
|
test('can strip dir number prefixes', () => {
|
|
expect(
|
|
getSlug({
|
|
baseID: 'doc',
|
|
dirName: '/001-dir1/002-dir2',
|
|
stripDirNumberPrefixes: true,
|
|
}),
|
|
).toEqual('/dir1/dir2/doc');
|
|
expect(
|
|
getSlug({
|
|
baseID: 'doc',
|
|
dirName: '/001-dir1/002-dir2',
|
|
stripDirNumberPrefixes: false,
|
|
}),
|
|
).toEqual('/001-dir1/002-dir2/doc');
|
|
});
|
|
|
|
// See https://github.com/facebook/docusaurus/issues/3223
|
|
test('should handle special chars in doc path', () => {
|
|
expect(
|
|
getSlug({baseID: 'my dôc', dirName: '/dir with spâce/hey $hello'}),
|
|
).toEqual('/dir with spâce/hey $hello/my dôc');
|
|
});
|
|
|
|
test('should handle current dir', () => {
|
|
expect(getSlug({baseID: 'doc', dirName: '.'})).toEqual('/doc');
|
|
expect(getSlug({baseID: 'doc', dirName: '/'})).toEqual('/doc');
|
|
});
|
|
|
|
test('should resolve absolute slug frontmatter', () => {
|
|
expect(
|
|
getSlug({baseID: 'any', dirName: '.', frontmatterSlug: '/abc/def'}),
|
|
).toEqual('/abc/def');
|
|
expect(
|
|
getSlug({baseID: 'any', dirName: './any', frontmatterSlug: '/abc/def'}),
|
|
).toEqual('/abc/def');
|
|
expect(
|
|
getSlug({
|
|
baseID: 'any',
|
|
dirName: './any/any',
|
|
frontmatterSlug: '/abc/def',
|
|
}),
|
|
).toEqual('/abc/def');
|
|
});
|
|
|
|
test('should resolve relative slug frontmatter', () => {
|
|
expect(
|
|
getSlug({baseID: 'any', dirName: '.', frontmatterSlug: 'abc/def'}),
|
|
).toEqual('/abc/def');
|
|
expect(
|
|
getSlug({baseID: 'any', dirName: '/dir', frontmatterSlug: 'abc/def'}),
|
|
).toEqual('/dir/abc/def');
|
|
expect(
|
|
getSlug({
|
|
baseID: 'any',
|
|
dirName: 'unslashedDir',
|
|
frontmatterSlug: 'abc/def',
|
|
}),
|
|
).toEqual('/unslashedDir/abc/def');
|
|
expect(
|
|
getSlug({
|
|
baseID: 'any',
|
|
dirName: 'dir/subdir',
|
|
frontmatterSlug: 'abc/def',
|
|
}),
|
|
).toEqual('/dir/subdir/abc/def');
|
|
expect(
|
|
getSlug({baseID: 'any', dirName: '/dir', frontmatterSlug: './abc/def'}),
|
|
).toEqual('/dir/abc/def');
|
|
expect(
|
|
getSlug({
|
|
baseID: 'any',
|
|
dirName: '/dir',
|
|
frontmatterSlug: './abc/../def',
|
|
}),
|
|
).toEqual('/dir/def');
|
|
expect(
|
|
getSlug({
|
|
baseID: 'any',
|
|
dirName: '/dir/subdir',
|
|
frontmatterSlug: '../abc/def',
|
|
}),
|
|
).toEqual('/dir/abc/def');
|
|
expect(
|
|
getSlug({
|
|
baseID: 'any',
|
|
dirName: '/dir/subdir',
|
|
frontmatterSlug: '../../../../../abc/../def',
|
|
}),
|
|
).toEqual('/def');
|
|
});
|
|
});
|