GithubHelp home page GithubHelp logo

Comments (6)

filzrev avatar filzrev commented on June 16, 2024 3

@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.

filzrev avatar filzrev commented on June 16, 2024 2

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.

filzrev avatar filzrev commented on June 16, 2024 1

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.

filzrev avatar filzrev commented on June 16, 2024 1

There is a following issue when talking about resolving xrefs.

It seems be caused by #9677 issue.

from docfx.

Kevinf63 avatar Kevinf63 commented on June 16, 2024

@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>

image

from docfx.

Delsin-Yu avatar Delsin-Yu commented on June 16, 2024

There is a following issue when talking about resolving xrefs,, should I open a separate issue on it? Since it's not markdown-related.
image
https://delsin-yu.github.io/GDViews.VirtualGridView/api/GodotViews.VirtualGrid.DynamicGridViewers.html

from docfx.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.