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.

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

Conversation

mikelau13
Copy link

No description provided.

Copy link
Owner

@Pxtl Pxtl left a comment

Choose a reason for hiding this comment

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

Looks good. Some suggestions for improvement.

@@ -29,6 +29,14 @@ public TagRenderer(string formatString, Func<XElement, ConversionContext, IEnume
x.Element("members").Elements("member").ToMarkDown(context.MutateAssemblyName(x.Element("assembly").Element("name").Value))
}
),
["br"] = new TagRenderer(
"\n",
Copy link
Owner

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

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.

@cpboyd
Copy link

cpboyd commented Jul 2, 2018

I've created my own fork and taken an initial stab at trying to fix anchor links and such:
cpboyd@fc0fab7

It also adds other things beyond the scope of this PR, like a few more HTML and Sandcastle/NDoc tags.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants