Skip to content

Markdown template tweaks #2162

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

Merged
merged 7 commits into from
Mar 30, 2020
Merged

Markdown template tweaks #2162

merged 7 commits into from
Mar 30, 2020

Conversation

jdkoren
Copy link
Contributor

@jdkoren jdkoren commented Mar 13, 2020

Lots of little tweaks that increase readability of the generated markdown. Some notable issues remain:

  • Angle brackets are tricky. We need to escape some so that they aren't interpreted as HTML tags (e.g. <B>), however we also end up escaping brackets in source code snippets.
  • Special directives like @tool seem to not work

@googlebot googlebot added the cla: yes Google CLA check succeeded. label Mar 13, 2020
@jdkoren
Copy link
Contributor Author

jdkoren commented Mar 13, 2020

Index.md
_tmp_dartdoc_test_md_index md

ex_library.md
_tmp_dartdoc_test_md_ex_ex-library md

Klass-class.md
_tmp_dartdoc_test_md_ex_Klass-class md

invokeTool.md
_tmp_dartdoc_test_md_ex_ToolUser_invokeTool md

@jdkoren jdkoren requested a review from jcollins-g March 13, 2020 15:54
@@ -7,10 +7,11 @@
{{>categorization}}

{{#hasNoGetterSetter}}
{{{ linkedReturnType }}} {{>name_summary}}
{{{ linkedReturnType }}} {{>name_summary}} {{!two spaces intentional}}
Copy link
Contributor

Choose a reason for hiding this comment

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

What is the purpose of "two spaces intentional"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Two spaces at the end of a line renders a line break, but not a paragraph break.

Normally a line break just renders a space (unless there's other formatting involved, like headings). Two line breaks renders a paragraph break, separating the blocks with extra vertical space that I didn't want.

@jdkoren jdkoren merged commit 578400c into dart-lang:master Mar 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Google CLA check succeeded.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants