GithubHelp home page GithubHelp logo

Comments (2)

NattyXO avatar NattyXO commented on June 22, 2024

The error you're encountering with DocFX seems related to the expectation of a specific filename ("xrefmap.yml") when utilizing the xrefmap in a zip archive. DocFX's current implementation might not be compatible with the xrefmap in JSON format archived as a zip file.

To address this:

  1. Format of xrefmap:
    Currently, it seems that DocFX expects the xrefmap file to be in YAML format with the name "xrefmap.yml". This might be a limitation in the current implementation of DocFX, which doesn't support xrefmap in JSON format when using it within a zip archive.

  2. Alternative Approach:
    As a workaround, you might need to generate or convert the xrefmap to YAML format and name it "xrefmap.yml". This way, it aligns with DocFX's current expectations. Tools or scripts to convert JSON to YAML might be helpful in achieving this conversion.

  3. Equivalent xrefmap.yml URL:
    Regarding an equivalent xrefmap.yml file URL for "https://learn.microsoft.com/en-us/dotnet/.xrefmap.json", it might not have an exact equivalent as xrefmap files could be specific to the structure and content of a particular documentation set.

For downloading the xrefmap.yml file, it might not exist as a direct replacement for the JSON file you mentioned. The xrefmap might be generated by specific tools or processes within a documentation system.

Given the limitation you've encountered with DocFX's handling of xrefmap, you might want to consider:

  • Checking for any updates or releases in the DocFX repository that might address this limitation.
  • Reaching out to the DocFX community or raising an issue in their repository to get insights or potential workarounds from developers who have encountered a similar situation.

For a seamless integration, it's ideal for the tool to support xrefmap in various formats, including JSON, when archived as a zip file. However, until this is supported in DocFX, converting the JSON xrefmap to YAML or exploring alternative solutions might be necessary.

from docfx.

filzrev avatar filzrev commented on June 22, 2024

Is there xrefmap.yml file download URL.
That is equivalent to https://learn.microsoft.com/en-us/dotnet/.xrefmap.json ?

I've confirmed xrefmap YAML version can be downloadable from following URL (It need to remove heading dot from file name).
https://learn.microsoft.com/en-us/dotnet/xrefmap.yml

And it can download YAML as zip with following command.

docfx download -x https://learn.microsoft.com/en-us/dotnet/xrefmap.yml xrefmap.zip

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.