Markdown versus HTML
Use either HTML or Markdown. Some of this style guide assumes that you're using HTML. If you're
using Markdown, details like what HTML elements to use in various contexts might be
irrelevant to you.
Markdown is easier to write than HTML, and it's easier for most humans to
read Markdown source than HTML source. However, HTML is more expressive
(particularly regarding semantic tagging)
and can achieve some specific effects that might be difficult or impossible in
Markdown. For example, you might have to switch to using the HTML code element
for special characters in code such as nonbreaking spaces.
In the end, which one to use is primarily a matter of personal preference;
however, if your team or your document template already uses one or the other,
it may be best to use whatever they use.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-15 UTC.
[null,null,["Last updated 2024-10-15 UTC."],[[["You can use either HTML or Markdown for content creation."],["Markdown is generally easier to read and write, but HTML offers more flexibility and control."],["The choice between the two depends on personal preference and existing team/document conventions."]]],["Markdown is simpler to write and read than HTML, while HTML offers greater expressiveness, especially in semantic tagging, and can handle specific effects like special characters in code. The choice between them depends on personal preference, though team or document template standards should be prioritized. Markdown might require switching to HTML elements for certain effects. Ultimately, both formats are acceptable, and the decision should be based on the project and the team.\n"]]
