Skip to content

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

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

Open
mikelau13 wants to merge 3 commits into
base: master
Choose a base branch
from
Open

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

Changes from all commits
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
8 changes: 8 additions & 0 deletions PxtlCa.XmlCommentMarkDownGenerator/TagRenderers.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ public Func<
x.Element("members").Elements("member").ToMarkDown(context.MutateAssemblyName(x.Element("assembly").Element("name").Value))
}
),
["br"] = new TagRenderer(
"\n",
Copy link
Owner

@Pxtl Pxtl Jun 19, 2018

Choose a reason for hiding this comment

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

For proper markdown, shouldn't it be "\n " with two trailing space afterwards? Then it's compatible with standard-markdown in addition to github-flavored markdown.

https://stackoverflow.blog/2009/10/15/markdown-one-year-later/

(x, context) => new string[0]
),
["seealso"] = new TagRenderer(
"##### See also: {0}\n",
Copy link
Owner

@Pxtl Pxtl Jun 19, 2018

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",
(x, context) => XmlToMarkdown.ExtractNameAndBodyFromMember(x, context)
Expand Down