Skip to content

Commit

Permalink
enhance docs with xrefmap
Browse files Browse the repository at this point in the history
  • Loading branch information
iJungleboy committed Jun 28, 2024
1 parent e7732ec commit f9a5c86
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@
]
}
],
// The XREFs contain shorthand links to other pages or even external sites/documentations.
"xref": [
"xrefmap.yml"
],
"resource": [
{
// Note: new docfx convention places things in /pages
Expand Down
19 changes: 19 additions & 0 deletions src/xrefmap.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#
# This file contains a map of links we will often use,
# which can be referenced in the markdown files or in the oqtane source code.
# So it provides a short name, such as `Oqtane.Source`
# which can be linked as [](xref:Oqtane.Source)
#
# Some instructions:
# - Comments start with a `#`
# - Each link is a list item starting with `- uid: ...`
# - The `uid` is the short name, which can be used in markdown files
# - The `name` is the text which will be displayed in the markdown file
# - The `href` is the URL which will be linked to

references:

# Oqtane Core Links
- uid: Oqtane.Source
name: Oqtane Source Code
href: https://github.com/oqtane/oqtane.framework

0 comments on commit f9a5c86

Please sign in to comment.