Comments (6)
@Kevinf63
It seems xref
is not resolved as expected on official docs.
(it's resolved by xrefService
before but it's retired #9659)
I've created PR(#9880) to resolve xref resolver issue on conceptual documentation.
from docfx.
does not resolve when converted to markdown, this is what appears in the GitHub.
Currently generated markdown files with "outputFormat": "markdown"
option are intended to be used as docfx build
command inputs.
So generated markdown files contains some docfx specific custom tags like <xref>
.
And these custom tags are ignored by GitHub's markdown preview.
Raw
view of generated file
https://raw.githubusercontent.com/Delsin-Yu/GDViews.VirtualGridView/main/Documentation/GodotViews.VirtualGrid.md
If there are no strict requirements for previewing the markdown file on GitHub.
Try to publish document to GitHub Pages
from docfx.
It seems resolved by publishing docs to GitHub pages.
And official docs xref problems are resolved by merged PR.
@Delsin-Yu
If there is no additional problems. Please close this issue.
from docfx.
There is a following issue when talking about resolving xrefs.
It seems be caused by #9677 issue.
from docfx.
@Delsin-Yu and @filzrev, I similarly ran into this with "outputFormat": "markdown"
. I think a good live example of this issue is visible in DocFx's own cross referencing documentation:
Not sure if it's intentional or a mistake?
https://dotnet.github.io/docfx/docs/links-and-cross-references.html#more-options-for-cross-referencing-net-api-docs
<p>
e.g.:
<code>
[](xref:System.String?title=String+Class)
</code>
will be resolved as
<a href="xref:System.String?title=String+Class"></a>.
</p>
from docfx.
There is a following issue when talking about resolving xrefs,, should I open a separate issue on it? Since it's not markdown-related.
https://delsin-yu.github.io/GDViews.VirtualGridView/api/GodotViews.VirtualGrid.DynamicGridViewers.html
from docfx.
Related Issues (20)
- [Bug] Unable to find package docs.validation, Microsoft.Docs.MetadataService.Models, docs.validation.analyzer HOT 1
- [Feature Request] Create Class, Interface and Enums as expanders in the TOC for .NET Documentation HOT 4
- [Bug] .NET API bug - Nullable project throws error telling I should enable nullable HOT 3
- [Bug] Build-time TOC customization with `toc.extension.js` is not works when using `modern` template HOT 1
- [Bug] DocfxException: Cannot find .NET Core SDK to compile the project (but .net core 8.0.300 sdk is installed) HOT 1
- [Feature Request] Include Markdown Files by UID
- [Bug] Opening angle bracket not escaped in Markdown output HOT 1
- [Bug] Navigation area left-margin is changed when navigating between pages
- [Feature Request] Supports MPA View Transition
- [Feature Request] Unable to customize the "Inherited members" section using class.header.tmpl.partial when using apiPage outputFormat.
- [Feature Request] Add MarkdownContext to BuildOptions.ConfigureMarkdig
- [Feature Request] Support faster deserialization of `OneOf` based types
- [Bug] Ignoring global namespace prevents metadata to generate api folder HOT 5
- [Feature Request] Generate docs ONLY for stuff with the /// comment. HOT 2
- [Feature Request] Additional Schemas HOT 1
- [Feature Request] Support `Overwrite Files` feature for `"outputFormat": "apiPage"`
- [Bug] DotnetApiCatalog.GenerateManagedReferenceYamlFiles() hangs indefinitely on 2.76.0 HOT 2
- [Feature Request] My awesome feature
- [Feature Request] Allow SourceLink support to be disabled
- [Feature Request] Create Categories or Tags for search
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docfx.