dotnet / dotnet/docfx

Custom xrefProperties for Conceptual Documents

Open
#8,401 0 comments 0 reactions 0 assignees View on GitHub
markdown
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

I have conceptual documents with headers like this:

```yml
---
uid: Fpp-Bar
title: Foo the Bar
longTitle: How can I foo the bar while the bar is fooing the foo?
---
```

Now I want to be able to use the long title for display in links, like for example: `@Foo-Bar?displayName=longTitle` and I would also like to have longTitle in the xrefMap file.

I have seen that the document schema definitions can specifiy the properties used for xref through the `xrefProperties` property.
That makes sense so far, but what's totally unclear to me is how to get this going practically with my conceptual documents.

What's the trick?

Thanks,
sw

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.