Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added <br/> and <seealso cref=xxx> #26

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+8 −0
Open

Added <br/> and <seealso cref=xxx> #26

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
de46c31
Fixed issues: missing <br> and <seealso>; when target directory does …
mikelau13 May 29, 2018
827083e
removed codes to makedir
mikelau13 May 29, 2018
9e1ada7
Fixed "seealso"
mikelau13 May 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Fixed "seealso"
@mikelau13
mikelau13 committed May 29, 2018
commit 9e1ada712eb3239a1bca512e95351fc12d6e4dc3
4 changes: 2 additions & 2 deletions PxtlCa.XmlCommentMarkDownGenerator/TagRenderers.cs
View file
Original file line number Diff line number Diff line change
@@ -34,8 +34,8 @@ public Func<
(x, context) => new string[0]
),
["seealso"] = new TagRenderer(
"## \n\n",
(x, context) => new[] { x.Nodes().ToMarkDown(context) }
"##### See also: {0}\n",
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If possible (and consider this just a suggestion):

https://gist.github.com/asabaylus/3071099

Github-flavoured markdown automatically generates an anchor for each heading. That means that seealso could be an intra-document link.

(x, context) => XmlToMarkdown.ExtractNameAndBody("cref", x, context)
),
["type"] = new TagRenderer(
"## {0}\n\n{1}\n\n---\n",