dotnet / dotnet/docfx

Automatically generated links based on class names in documentation.

Open
#3,191 0 comments 0 reactions 0 assignees View on GitHub
dotnet xref
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

Hi all,
Docfx is something new for me and and I'm not so familiar with this project. I've read some documentation but actually I couldn't find informations that I've been looking for. Namely I would like to know if with Docfx there exists such possiblity:
1. I have C# project in VS.

2. I have my own webpage where are accurately derscribed all classes, interfaces, etc. (generally enties) from my project with such convention:
https://my_page_name/display/[my_project_name]+Article
where 'Article' is truncate name of my class 'ArticleDTO' from VS project . All other enties are described in the same way.

3. Now I would like to generate documentation in way where for each class-entity from VS I have a link in header above to corresponding webpage. For example let's look at this 'ArticleDTO' - I would like to set Docfx to generate specific link with such rule: take prefix
'https://my_page_name/display/[my_project_name]+'
and also take my class name 'ArticleDTO', cut 'DTO' part and concentate with prefix above so that in documentation there would show proper link:
'https://my_page_name/display/[my_project_name]+Article'.
Next use tag to link 'here' in "Click here for more details of this component" sentence with generated link so that in description of class in generated documentation I would have something like this:
![howitschouldlook](https://user-images.githubusercontent.com/38755169/44043814-0bf6d3cc-9f24-11e8-95d0-340bdefe5fe0.PNG)

I emphasize that I don't want to manually write links to webpages in XML comments in VS project. I would like to do it automatically through Docfx. I've already tried using Sandcastle tool but it doesn't allow such functionality.

Could You help me with this case please?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.