How to generate document automation attach image link

[chuongmep]

Describe the solution you'd like
Hi team, at the moment, I need move this source to docfx, but I don't know how can do with same format also automation attacth image sample bellow function API, it is can do with docfx ?
This is document I created and I want move to docfx: https://chuongmep.github.io/OpenMEP/element/element.html

Any comment appreciate !

[yufeih]

Does markdown image link in XML comment work?

[chuongmep]

@yufeih it is not working for me now, with one method, I need demo one image, so I can't create a lot markdown for that. Example :

/// [!INCLUDE [Image](../../docs/OpenMEPPage/element/family/dyn/pic/Family.EditFamily.png)]

and then it is result :

I hope to have a guideline for single image like video in here :

[yufeih]

Here is the markdown image syntax ![alt text](image.png "Title")

[chuongmep]

Hi @yufeih , have a warning relate for that. This is project open source, can help me review for that ?

• Project : https://github.com/chuongmep/OpenMEP
• Location of docfx.json : https://github.com/chuongmep/OpenMEP/blob/dev/docfx_project/docfx.json
• Location of method : https://github.com/chuongmep/OpenMEP/blob/db347bc0dca19b27148dfb3509fbd3bedd8a79ac/OpenMEP/Application/Dynamo.cs#L19
• Location of image : https://github.com/chuongmep/OpenMEP/tree/dev/docs/OpenMEPPage/application/dyn/pic
  Warning :
  warning InvalidFileLink: Invalid file link:(~/../docs/OpenMEPPage/application/dyn/pic/Dyna
  mo.Version.png).

[yufeih]

Aha, you hit the issue that docfx cannot reference stuff outside of the docfx.json folder, can the docfx.json be moved to docs/docfx.json?

[chuongmep]

@yufeih tried move but still same problem, this is a log :

Using .NET Core SDK 6.0.402
Loading project C:/Users/chuon/RiderProjects/GlobalMEP/OpenMEP/OpenMEP.csproj
[Warning] Found project reference without a matching metadata reference: C:\Users\chuon\RiderProjects\GlobalMEP\OpenMEPViewExtension\OpenMEPViewExtension.csproj
[Warning] Found project reference without a matching metadata reference: C:\Users\chuon\RiderProjects\GlobalMEP\OpenMEPSandbox\OpenMEPSandbox.csproj
Processing OpenMEP
Processing OpenMEPSandbox
Creating output...
Completed Scope:MetadataCommand in 6171.3058 milliseconds.
Searching custom plugins in directory C:\Users\chuon\.dotnet\tools\.store\docfx\2.62.1\docfx\2.62.1\tools\net6.0\any\...
6 plug-in(s) loaded.
No files are found with glob pattern apidoc/**.md, excluding obj/**,_site/**, under directory "C:\Users\chuon\RiderProjects\GlobalMEP\docs"
Max parallelism is 8.
Unable to handle following files: api/toc.yml.bak. Do they miss `YamlMime` as the first line of file, e.g.: `### YamlMime:ManagedReference`?
Building 2 file(s) in TocDocumentProcessor(BuildTocDocument)...
Building 1 file(s) in ResourceDocumentProcessor(ValidateResourceMetadata)...
Building 70 file(s) in ManagedReferenceDocumentProcessor(BuildManagedReferenceDocument=>ValidateManagedReferenceDocumentMetadata=>ApplyOverwriteDocumentForMref=>FillReferenceInformatio
n)...
Building 2 file(s) in ConceptualDocumentProcessor(BuildConceptualDocument=>CountWord=>ValidateConceptualDocumentMetadata)...
1 external references found in 1 xref maps.
Applying templates to 75 model(s)...
XRef map exported.
Manifest file saved to manifest.json.
Completed building documents in 3249.5072 milliseconds.
Serving "C:\Users\chuon\RiderProjects\GlobalMEP\docs\_site" on http://localhost:8080. Press Ctrl+C to shut down.

Docs :

Folder after move :

Command : docfx docs/docfx.json --serve

[chuongmep]

One more information : With insert .cs file, it's working normal, but image still same :

/// <summary>
    /// return current version of dynamo
    /// </summary>
    /// <returns name="version">version</returns>
    /// <example>
    /// ![alt text](../../docs/OpenMEPPage/application/dyn/pic/Dynamo.Version.png "Dynamo")
    /// [!code-csharp[](../../docs/sample/navis.cs)]
    /// </example>

[chuongmep]

Hi @yufeih , after try snoop something in html file, I think I resolved my problem by short path, add string title can't generate image:

• Image : ![](../OpenMEPPage/application/dyn/pic/Dynamo.Version.png)