5 lines
74 KiB
JSON
5 lines
74 KiB
JSON
|
{
|
||
|
|
"id": "guide/docs-style-guide",
|
||
|
|
"title": "Angular documentation style guide",
|
||
|
|
"contents": "\n\n\n<div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/aio/content/guide/docs-style-guide.md?message=docs%3A%20describe%20your%20change...\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n</div>\n\n\n<div class=\"content\">\n <h1 id=\"angular-documentation-style-guide\">Angular documentation style guide<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/docs-style-guide#angular-documentation-style-guide\"><i class=\"material-icons\">link</i></a></h1>\n<p>This style guide covers the standards for writing <a href=\"https://angular.io/docs\">Angular documentation on angular.io</a>.\nThese standards ensure consistency in writing style, Markdown conventions, and code snippets.</p>\n<h2 id=\"prerequisites\">Prerequisites<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/docs-style-guide#prerequisites\"><i class=\"material-icons\">link</i></a></h2>\n<p>Before contributing to the Angular documentation, it is helpful if you are familiar with the following:</p>\n<ul>\n<li><code>git</code>: for an introduction, see GitHub's <a href=\"https://guides.github.com/introduction/git-handbook/\">Git Handbook</a></li>\n<li><code>GitHub</code>: for an introduction, see GitHub's <a href=\"https://guides.github.com/activities/hello-world/\">Hello World</a></li>\n<li>Markdown: see GitHub's <a href=\"https://guides.github.com/features/mastering-markdown/\">Mastering Markdown</a></li>\n<li>Angular coding style: see the <a href=\"guide/styleguide\" title=\"Angular Application Code Style Guide\">Angular Style Guide</a></li>\n<li>Google writing style: The <a href=\"https://developers.google.com/style/\">Google Developer Documentation Style Guide</a> is a comprehensive resource that this Angular documentation style guide builds upon.</li>\n</ul>\n<h2 id=\"kinds-of-angular-documentation\">Kinds of Angular documentation<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/docs-style-guide#kinds-of-angular-documentation\"><i class=\"material-icons\">link</i></a></h2>\n<p>The categories of Angular documentation include:</p>\n<ul>\n<li><a href=\"docs\">Guides</a>: much of what's in the <a href=\"docs\">documentation section of angular.io</a>.\nGuides walk the reader step-by-step through tasks to demonstrate concepts and are often accompanied by a working example.\nThese include <a href=\"start\">Getting Started</a>, <a href=\"tutorial\">Tour of Heroes</a>, and pages about <a href=\"guide/forms-overview\">Forms</a>, <a href=\"guide/dependency-injection\">Dependency Injection</a>, and <a href=\"guide/http\">HttpClient</a>.\nContributing members of the community and Angular team members maintain this documentation in <a href=\"https://daringfireball.net/projects/markdown/syntax\" title=\"Markdown\">Markdown</a>.</li>\n<li><a href=\"api\">API documentation</a>: reference documents for the <a href=\"api\">Angular Application Programming Interface, or API</a>.\nThese are more succinct than guides and serve as a reference for Angular features.\nThey are especially helpful for people already acquainted with Angular concepts.\nThe <a href=\"https://angular.io/\">angular.io</a> infrastructure generates these documents from source code and comments that contributors edit.</li>\n<li><a href=\"cli\">CLI documentation</a>: the <a href=\"https://angular.io/\">angular.io</a> infrastructure generates these documents from CLI source code.</li>\n</ul>\n<h2 id=\"markdown-and-html\">Markdown and HTML<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/docs-style-guide#markdown-and-html\"><i class=\"material-icons\">link</i></a></h2>\n<p>While the Angular guides are <a href=\"https://daringfireball.net/projects/markdown/syntax\" title=\"Markdown\">Markdown</a> files, there are some sections within the guides that use HTML.</p>\n<div class=\"alert is-helpful\">\n<p> To enable HTML in an A
|
||
|
|
}
|