honeymoose/angular-cn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
13,691 Commits 5 Branches 1 Tag
Commit Graph

51 Commits

Author SHA1 Message Date
Zhicheng Wang
deeeaa9647 docs: 修正坏链 2018-10-22 18:47:41 +08:00
Zhicheng Wang
a9ac90d3df Merge remote-tracking branch 'en/master' into aio 
# Conflicts:
#	aio/content/guide/ajs-quick-reference.md
#	aio/content/guide/animations.md
#	aio/content/guide/aot-compiler.md
#	aio/content/guide/architecture-components.md
#	aio/content/guide/architecture-modules.md
#	aio/content/guide/architecture-next-steps.md
#	aio/content/guide/architecture-services.md
#	aio/content/guide/architecture.md
#	aio/content/guide/attribute-directives.md
#	aio/content/guide/bootstrapping.md
#	aio/content/guide/browser-support.md
#	aio/content/guide/cheatsheet.md
#	aio/content/guide/comparing-observables.md
#	aio/content/guide/component-interaction.md
#	aio/content/guide/component-styles.md
#	aio/content/guide/dependency-injection-in-action.md
#	aio/content/guide/dependency-injection-pattern.md
#	aio/content/guide/dependency-injection.md
#	aio/content/guide/deployment.md
#	aio/content/guide/displaying-data.md
#	aio/content/guide/dynamic-component-loader.md
#	aio/content/guide/elements.md
#	aio/content/guide/feature-modules.md
#	aio/content/guide/form-validation.md
#	aio/content/guide/forms.md
#	aio/content/guide/glossary.md
#	aio/content/guide/hierarchical-dependency-injection.md
#	aio/content/guide/i18n.md
#	aio/content/guide/lazy-loading-ngmodules.md
#	aio/content/guide/lifecycle-hooks.md
#	aio/content/guide/ngmodule-faq.md
#	aio/content/guide/ngmodule-vs-jsmodule.md
#	aio/content/guide/ngmodules.md
#	aio/content/guide/npm-packages.md
#	aio/content/guide/observables-in-angular.md
#	aio/content/guide/observables.md
#	aio/content/guide/pipes.md
#	aio/content/guide/practical-observable-usage.md
#	aio/content/guide/providers.md
#	aio/content/guide/quickstart.md
#	aio/content/guide/reactive-forms.md
#	aio/content/guide/router.md
#	aio/content/guide/rx-library.md
#	aio/content/guide/security.md
#	aio/content/guide/service-worker-communications.md
#	aio/content/guide/service-worker-getting-started.md
#	aio/content/guide/service-worker-intro.md
#	aio/content/guide/setup-systemjs-anatomy.md
#	aio/content/guide/setup.md
#	aio/content/guide/singleton-services.md
#	aio/content/guide/structural-directives.md
#	aio/content/guide/styleguide.md
#	aio/content/guide/template-syntax.md
#	aio/content/guide/testing.md
#	aio/content/guide/typescript-configuration.md
#	aio/content/guide/universal.md
#	aio/content/guide/updating.md
#	aio/content/guide/upgrade.md
#	aio/content/guide/user-input.md
#	aio/content/guide/visual-studio-2015.md
#	aio/content/marketing/docs.md
#	aio/content/navigation.json
#	aio/content/tutorial/toh-pt0.md
#	aio/content/tutorial/toh-pt1.md
#	aio/content/tutorial/toh-pt2.md
#	aio/content/tutorial/toh-pt3.md
#	aio/content/tutorial/toh-pt4.md
#	aio/content/tutorial/toh-pt5.md
#	aio/content/tutorial/toh-pt6.md
#	aio/ngsw-manifest.json
#	aio/package.json
#	aio/src/app/custom-elements/api/api-list.component.html
#	aio/src/app/custom-elements/api/api-list.component.ts
#	aio/src/index.html
#	aio/tools/transforms/templates/api/base.template.html
#	aio/tools/transforms/templates/api/class.template.html
#	aio/tools/transforms/templates/api/directive.template.html
#	aio/tools/transforms/templates/api/enum.template.html
#	aio/tools/transforms/templates/api/includes/class-overview.html
#	aio/tools/transforms/templates/api/includes/deprecation.html
#	aio/tools/transforms/templates/api/includes/export-as.html
#	aio/tools/transforms/templates/api/includes/info-bar.html
#	aio/tools/transforms/templates/api/includes/interface-overview.html
#	aio/tools/transforms/templates/api/includes/selectors.html
#	aio/tools/transforms/templates/api/lib/directiveHelpers.html
#	aio/tools/transforms/templates/api/lib/githubLinks.html
#	aio/tools/transforms/templates/api/lib/memberHelpers.html
#	aio/tools/transforms/templates/api/package.template.html
#	aio/yarn.lock
#	packages/common/http/src/module.ts
#	packages/common/src/common_module.ts
#	packages/common/src/directives/ng_for_of.ts
#	packages/common/src/directives/ng_if.ts
#	packages/common/src/directives/ng_template_outlet.ts
#	packages/common/src/location/location.ts
#	packages/common/src/pipes/async_pipe.ts
#	packages/common/src/pipes/json_pipe.ts
#	packages/common/src/pipes/number_pipe.ts
#	packages/common/src/pipes/slice_pipe.ts
#	packages/core/src/change_detection/change_detector_ref.ts
#	packages/core/src/di/injectable.ts
#	packages/core/src/linker/template_ref.ts
#	packages/core/src/linker/view_container_ref.ts
#	packages/core/src/metadata/di.ts
#	packages/core/src/metadata/ng_module.ts
#	packages/core/src/render/api.ts
#	packages/forms/src/directives/form_interface.ts
#	packages/forms/src/directives/ng_form.ts
#	packages/forms/src/directives/ng_model.ts
#	packages/forms/src/directives/reactive_directives/form_control_name.ts
#	packages/forms/src/directives/select_control_value_accessor.ts
#	packages/forms/src/directives/validators.ts
#	packages/forms/src/form_providers.ts
#	packages/forms/src/model.ts
#	packages/forms/src/validators.ts
#	packages/router/src/config.ts
#	packages/router/src/router.ts
#	packages/router/src/router_module.ts
#	packages/router/src/router_state.ts
 2018-10-21 17:43:29 +08:00
Pete Bacon Darwin
4b1fd98093 build(docs-infra): pluralize NgModule(s) heading as appropriate (#25768) 
PR Close #25768
 2018-10-01 09:36:34 -07:00
Pete Bacon Darwin
935ef13096 build(docs-infra): improve directive selector rendering (#25768) 
`:not(...)` blocks are now rendered as italic, while the
rest of the selector is bold.

PR Close #25768
 2018-10-01 09:36:33 -07:00
Pete Bacon Darwin
15dadb92ef build(docs-infra): include directives etc in class descendants lists (#25768) 
PR Close #25768
 2018-10-01 09:36:33 -07:00
Pete Bacon Darwin
ce06a75ebf build(docs-infra): display inherited members on directives (#25768) 
PR Close #25768
 2018-10-01 09:36:33 -07:00
Pete Bacon Darwin
d0f7eadc09 build(docs-infra): rename example template variable in directive pages (#25768) 
PR Close #25768
 2018-10-01 09:36:33 -07:00
Pete Bacon Darwin
46729c76a0 build(docs-infra): improve directive selector rendering (#25768) 
If the documentation contains a `@selectors` tag then the content of that
is used to describe the selectors of a directive.

Otherwise the selector string is split and each selector is listed as
a list item in an unordered list.

PR Close #25768
 2018-10-01 09:36:33 -07:00
Pete Bacon Darwin
f22deb2e2d build(docs-infra): improve directive API doc templates (#25768) 
Closes #22790
Closes #25530

PR Close #25768
 2018-10-01 09:36:32 -07:00
Pete Bacon Darwin
026b60cd70 build(docs-infra): expose deprecated status on items more clearly (#25750) 
PR Close #25750
 2018-09-21 10:26:48 -07:00
Pete Bacon Darwin
b94436d86c build(docs-infra): process and render ngmodule exports (#25734) 
All directives and pipes must now be tagged with one ore more
public NgModule, from which they are exported.

If an item is exported transitively via a re-exported internal NgModule
then it may be that the item appears to be exported from more than
one public NgModule. For example, there are shared directives that
are exported in this way from `FormsModule` and `ReactiveFormsModule`.

The doc-gen will error and fail if a directive or pipe is not tagged correctly.

NgModule pages now list all the directives and pipes that are exported from it.
Directive and Pipe pages now list any NgModule from which they are exported.
Packages also now list any NgModules that are contained - previously they were
missed.

PR Close #25734
 2018-09-19 16:18:24 -07:00
Pete Bacon Darwin
bc5cb8153e build(docs-infra): separate NgModules from Classes in API docs (#25734) 
PR Close #25734
 2018-09-19 16:18:24 -07:00
Pete Bacon Darwin
34b848ad51 build(docs-infra): remove unused info-bar API template (#25734) 
PR Close #25734
 2018-09-19 16:18:24 -07:00
Martin Sikora
d539122466 refactor(docs-infra): refactor templates (#24378) 
PR Close #24378
 2018-08-31 09:42:10 -07:00
Martin Sikora
9533cc9809 feat(docs-infra): add "suggest edits" feature to all docs (#24378) 
PR Close #24378
 2018-08-31 09:42:10 -07:00
Zhicheng Wang
cb84b1d1c6 feat: 汉化 API 模板 2018-08-08 15:15:56 +08:00
Pete Bacon Darwin
edef58f466 build(docs-infra): ensure all API headings are sentence cased (#24949) 
Closes #24880

PR Close #24949
 2018-07-23 08:43:07 -07:00
Pete Bacon Darwin
8c51ce6f3b build(docs-infra): move overload short description above syntax (#24526) 
PR Close #24526
 2018-06-25 07:56:36 -07:00
Pete Bacon Darwin
45862d0812 build(docs-infra): ensure all headings are sentence cased (#24527) 
PR Close #24527
 2018-06-15 09:13:45 -07:00
Pete Bacon Darwin
39af314e29 build(aio): add github links to API doc members (#24000) 
This change adds Github edit and view links to methods
and decorator options.

It is possible to add these to properties also but the
UI is rather tight as these are displayed in a table.

PR Close #24000
 2018-06-13 16:47:40 -07:00
Pete Bacon Darwin
859a3d5784 build(aio): fix decorator doc "inherited from" heading (#24000) 
We should not include the package path in the inherited
from heading for decorator API docs

PR Close #24000
 2018-06-13 16:47:40 -07:00
Pete Bacon Darwin
e371b226fa build(aio): rearrange decorator API doc template (#24000) 
The overview of the decorator options is now a table.
The detailed description of each option is now a full section.

PR Close #24000
 2018-06-13 16:47:40 -07:00
Pete Bacon Darwin
d509bd6849 build(aio): improve the API Pipe pages (#22702) 
This change adds:

* an impure badge for Pipes that are marked as  `pure: false`
* a pipe specific overview that shows the syntax for using a pipe in a template.
* an "input value" section describing the type of the value that the pipe expects.
* a "pipe params" section describing any additional params that a pipe expects.

PR Close #22702
 2018-03-14 14:21:11 -07:00
Pete Bacon Darwin
cd58c0a6d9 build(aio): remove unwanted overview headings (#22681) 
PR Close #22681
 2018-03-12 11:23:47 -07:00
Pete Bacon Darwin
38fef1588d build(aio): move "see also" block to export-base template (#22681) 
This makes it easier for all the API docs to display "see also" links
in a consitent manner.

PR Close #22681
 2018-03-12 11:23:46 -07:00
Pete Bacon Darwin
b80fd6be58 build(aio): render whether API classes and members are abstract (#22563) 
Closes #22537

PR Close #22563
 2018-03-05 10:13:43 -08:00
Pete Bacon Darwin
b107131f8a build(aio): split the description property in API docs (#22401) 
* The first paragraph is now split off into the `shortDescription` property.
* Usage of `howToUse` and `whatItDoes` have been updated.
* The "Overview" heading for class is removed as it is self-evident
* The original horizontal rule styling below the main heading is removed as not part of the new design

Closes #22385

PR Close #22401
 2018-02-28 10:43:27 -08:00
Pete Bacon Darwin
c10c831b8e build(aio): render subclasses + see-also block in the main flow (#22445) 
Closes #22386

PR Close #22445
 2018-02-26 17:50:42 -08:00
Pete Bacon Darwin
25a43041d2 build(aio): group API members by type in overview (#22438) 
Now the overview groups the members in the following order:

* static properties
* static methods
* constructor
* instance properties
* instance members

Closes #22132

PR Close #22438
 2018-02-26 13:34:04 -08:00
Pete Bacon Darwin
7007f51c35 feat(aio): first pass API docs redesign (#21874) 
Includes:

* display ToC for API docs
* update dgeni-packages to 0.24.1
* add floating sidebar in API docs
* add breadcrumbs and structured data for Google crawler
* improved rendering of method overloads
* properties rendered in a table
* params rendered with docs
* removal of outdated "infobox" from all API docs

PR Close #21874
 2018-02-09 13:05:16 -08:00
Pete Bacon Darwin
c83c4168ca build(aio): upgrade to dgeni-packages 0.24.0 (#21802) 
This has two benefits:

* it prepares the way for the API docs update, which need parameter docs
* it doesn't incorrectly report dangling links for non-latin anchors

Closes #21306

PR Close #21802
 2018-01-31 10:20:37 -08:00
George Kalpakas
b2e902deb4 fix(aio): fix code highlight in API docs templates (#21630) 
Fixes #21108

PR Close #21630
 2018-01-19 13:23:41 -08:00
Pete Bacon Darwin
4ae546be1f build(aio): ensure decorators with shared interface types are found (#19361) 
Closes #19358
 2017-09-25 11:59:21 -07:00
Peter Bacon Darwin
77d24afea3 build(aio): improve rendering of directive selectors 2017-09-12 13:55:54 -04:00
Peter Bacon Darwin
39386eadea build(aio): do not render comments in decorators 
Closes #18873
 2017-09-12 13:52:02 -04:00
Peter Bacon Darwin
bd928f3dcc build(aio): render metadata members from decorator ancestors 2017-09-08 17:04:36 -04:00
Peter Bacon Darwin
e78402dd4c build(aio): render ancestor members in directives 
See `CheckBoxRequiredValidator` for an example.
 2017-09-08 17:04:28 -04:00
Pete Bacon Darwin
3c480e4e63 build(aio): support rendering of constructor overloads in API docs (#19042) 
Closes #18258
 2017-09-06 10:14:02 -07:00
Peter Bacon Darwin
35bc1eb218 build(aio): render the extends ancestors of classes in API docs (#18927) 
PR Close #18927
 2017-09-05 15:33:10 -05:00
WilliamKoza
36faba1aab fix(aio): add quote to module 2017-07-18 17:48:04 +01:00
Peter Bacon Darwin
a301dba68f build(aio): improve API docs layout and styling 2017-07-13 12:16:20 -07:00
Peter Bacon Darwin
f06ce9adc8 build(aio): truncate API overview parameters at one line 2017-07-13 12:16:20 -07:00
Peter Bacon Darwin
be3352a084 build(aio): render grouped overloads 2017-07-13 12:16:20 -07:00
Peter Bacon Darwin
998049ec9b build(aio): truncate API overview parameters at one line 2017-07-13 12:16:20 -07:00
Peter Bacon Darwin
470a7c6bcd build(aio): use dedicated overview for decorator API docs 2017-07-11 11:44:05 +01:00
Peter Bacon Darwin
3abf208235 build(aio): update doc-gen templates 2017-07-11 11:44:05 +01:00
George Kalpakas
65d49d5c94 fix(aio): temporarily remove link to source from the API pages (#17371) 
We need to come up with a better design (possibly involving an icon button) to
link to the source code (for viewing and/or editing).

Fixes #17254
 2017-06-09 14:14:39 -07:00
Peter Bacon Darwin
d5ce086089 build(aio): fix up API doc-gen templates 
* Remove whitespace before type specifiers
* Generate `new` and `call` member info for interfaces
* Ensure that there is no double space after class names
 2017-06-02 13:18:09 -04:00
Peter Bacon Darwin
cb2cb7c3bd build(aio): display "call" and "new" members of interfaces in API docs 2017-05-31 08:45:50 +03:00
Stefanie Fluin
d27588b5fb feat(aio): api label styles 
- Moved info bar section in pipe template to be the first section to match other templates
- Fixed label styling for type label
- Added label styling for status label
 2017-05-05 11:04:55 +01:00