honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
angular-cn/aio/content/guide/index.md

3.7 KiB
Raw Blame History

@title Documentation Overview

@intro How to read and use this documentation.

@description This page describes the Angular documentation at a high level. If you're new to Angular, you may want to visit "Learning Angular" first.

Themes

The documentation is divided into major thematic sections, each a collection of pages devoted to that theme.

<td>
  <b><a href="../quickstart.html">QuickStart</a></b>
</td>


<td>
  A first taste of Angular<span if-docs="ts"> with zero installation.       
        Run "Hello World" in an online code editor and start playing with live code</span>.
</td>

<td>
  <b>Guide</b>
</td>


<td>
  Learn the Angular basics (you're already here!) like the setup for local development,      
        displaying data and accepting user input, injecting application services into components,      
        and building simple forms.
</td>

<td>
  <b><a href="../api/">API Reference</a></b>
</td>


<td>
  Authoritative details about each of the Angular libraries.
</td>

<td>
  <b><a href="../tutorial/">Tutorial</a></b>
</td>


<td>
  A step-by-step, immersive approach to learning Angular that      
        introduces the major features of Angular in an application context.
</td>

<td>
  <b><a href="      ">Advanced</a></b>
</td>


<td>
  In-depth analysis of Angular features and development practices.
</td>

<td>
  <b><a href="../cookbook/">Cookbook</a></b>
</td>


<td>
  Recipes for specific application challenges, mostly code snippets with a minimum of exposition.      
        
</td>

A few early pages are written as tutorials and are clearly marked as such. The rest of the pages highlight key points in code rather than explain each step necessary to build the sample. You can always get the full source through the #{_liveLink}s.

Code samples

Each page includes code snippets from a sample application that accompanies the page. You can reuse these snippets in your applications.

Look for a link to a running version of that sample, often near the top of the page, such as this from the Architecture page. The link launches a browser-based, code editor where you can inspect, modify, save, and download the code.

Alternatively, you can run the example locally, next to those live-example links you have a download link. Just download, unzip, run npm install to install the dependencies and run it with npm start.

Reference pages

  • The Cheat Sheet lists Angular syntax for common scenarios.
  • The Glossary defines terms that Angular developers should know.
  • The [Change Log](guide/change-log) announces what's new and changed in the documentation.
    • * The [API Reference](api/) is the authority on every public-facing member of the Angular libraries.

    Feedback

    We welcome feedback!