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

Fix code snippets; more Markdown, less HTML #231

Merged
merged 5 commits into from
Nov 1, 2023
Merged

Fix code snippets; more Markdown, less HTML #231

merged 5 commits into from
Nov 1, 2023

Conversation

serge-s
Copy link
Contributor

@serge-s serge-s commented Oct 2, 2023

  • wrap code fragments in triple backticks where needed
  • add missing xml keyword to enable syntax highlighting
  • replace HTML tags with text equivalents where needed to fix issues like this:

image

```xml
<Property Id="SHDOCVW">
<DirectorySearch Id="WinDir" Path="[WindowsFolder]">
<DirectorySearch Id="Media" Path="Media">
Copy link
Member

Choose a reason for hiding this comment

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

Should be indented.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Corrected.

```xml
<Property Id="NGEN2DIR">
<DirectorySearch Id="Windows" Path="[WindowsFolder]">
<DirectorySearch Id="MS.NET" Path="Microsoft.NET">
Copy link
Member

Choose a reason for hiding this comment

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

Another indent.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Corrected too.

```xml
<Property Id="NGEN2DIR">
<DirectorySearch Id="Windows" Path="[WindowsFolder]">
<DirectorySearch Id="MS.NET" Path="Microsoft.NET">
Copy link
Member

Choose a reason for hiding this comment

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

Several indents here.

Copy link
Member

@barnson barnson Oct 4, 2023

Choose a reason for hiding this comment

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

Just notice it's correctly rendered here: https://documentation.help/WiX/parentdirectorysearch.htm

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed.

@barnson
Copy link
Member

barnson commented Oct 4, 2023

Other than whitespace, looks good.

@barnson barnson merged commit de27caa into wixtoolset:master Nov 1, 2023
2 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Nov 1, 2023
@barnson
Copy link
Member

barnson commented Nov 1, 2023

Thanks!

@serge-s serge-s deleted the fix_markdown_part_2 branch November 9, 2023 20:00
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants