Support mapping custom tags in mkdocs yaml parser (techdocs)

Signed-off-by: martina-equinix <martina.iglesias@eu.equinix.com>
This commit is contained in:
martina-equinix
2024-09-03 11:35:10 +02:00
parent db6bcfbabc
commit e6a0d4f7f0
3 changed files with 18 additions and 1 deletions
@@ -4,4 +4,9 @@ site_description: Test site description
markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_generator: !!python/object.apply:materialx.emoji.to_svg
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
@@ -247,6 +247,10 @@ describe('helpers', () => {
expect(updatedMkdocsYml.toString()).toContain(
"emoji_index: !!python/name:materialx.emoji.twemoji ''",
);
expect(updatedMkdocsYml.toString()).toContain(
'slugify: !!python/object/apply:pymdownx.slugs.slugify',
);
expect(updatedMkdocsYml.toString()).toContain('case: lower');
});
it('should not override existing repo_url in mkdocs.yml', async () => {
@@ -141,6 +141,14 @@ export const MKDOCS_SCHEMA = DEFAULT_SCHEMA.extend([
instanceOf: UnknownTag,
construct: (data: string, type?: string) => new UnknownTag(data, type),
}),
new Type('tag:', {
kind: 'mapping',
multi: true,
representName: o => (o as UnknownTag).type,
represent: o => (o as UnknownTag).data ?? '',
instanceOf: UnknownTag,
construct: (data: string, type?: string) => new UnknownTag(data, type),
}),
new Type('', {
kind: 'sequence',
multi: true,