Commit Graph

304 Commits

Author SHA1 Message Date
Zhicheng WANG 1d65a38dcf Revert "fix: move mark code to post-process-html step"
This reverts commit 0cb8d723
2019-01-01 19:16:14 +08:00
Zhicheng WANG 0cb8d723ac fix: move mark code to post-process-html step 2019-01-01 16:16:02 +08:00
Zhicheng WANG b018382e7d refactor: use standalone library instead of translator.js 2019-01-01 16:16:02 +08:00
Zhicheng WANG 8744f17f5d Merge remote-tracking branch 'en/master' into aio
# Conflicts:
#	aio/content/cli/index.md
#	aio/content/file-not-found.md
#	aio/content/guide/architecture-modules.md
#	aio/content/guide/architecture-services.md
#	aio/content/guide/build.md
#	aio/content/guide/deployment.md
#	aio/content/guide/elements.md
#	aio/content/guide/feature-modules.md
#	aio/content/guide/file-structure.md
#	aio/content/guide/forms-overview.md
#	aio/content/guide/glossary.md
#	aio/content/guide/i18n.md
#	aio/content/guide/npm-packages.md
#	aio/content/guide/releases.md
#	aio/content/guide/router.md
#	aio/content/guide/service-worker-config.md
#	aio/content/guide/service-worker-intro.md
#	aio/content/guide/testing.md
#	aio/content/guide/upgrade-performance.md
#	aio/content/navigation.json
#	aio/content/tutorial/toh-pt0.md
#	aio/content/tutorial/toh-pt5.md
#	aio/content/tutorial/toh-pt6.md
#	aio/package.json
#	aio/src/app/custom-elements/api/api-list.component.ts
#	aio/src/app/documents/document.service.ts
#	aio/src/app/layout/top-menu/top-menu.component.ts
#	aio/src/index.html
#	aio/src/styles/2-modules/_api-pages.scss
#	aio/tools/transforms/templates/api/base.template.html
#	aio/tools/transforms/templates/api/lib/memberHelpers.html
#	aio/tools/transforms/templates/cli/cli-container.template.html
#	aio/tools/transforms/templates/lib/githubLinks.html
#	aio/yarn.lock
#	packages/animations/src/animation_metadata.ts
#	packages/common/http/src/backend.ts
#	packages/common/http/src/client.ts
#	packages/common/http/src/headers.ts
#	packages/common/http/src/interceptor.ts
#	packages/common/http/src/module.ts
#	packages/common/http/src/params.ts
#	packages/common/http/src/request.ts
#	packages/common/http/src/response.ts
#	packages/common/src/common_module.ts
#	packages/common/src/directives/ng_class.ts
#	packages/common/src/directives/ng_style.ts
#	packages/common/src/directives/ng_switch.ts
#	packages/common/src/i18n/format_date.ts
#	packages/common/src/pipes/number_pipe.ts
#	packages/core/src/change_detection/change_detection_util.ts
#	packages/core/src/change_detection/pipe_transform.ts
#	packages/core/src/di/injectable.ts
#	packages/core/src/linker/element_ref.ts
#	packages/core/src/linker/template_ref.ts
#	packages/core/src/metadata/di.ts
#	packages/core/src/metadata/directives.ts
#	packages/core/src/metadata/lifecycle_hooks.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_builder.ts
#	packages/forms/src/form_providers.ts
#	packages/forms/src/model.ts
#	packages/forms/src/validators.ts
#	packages/platform-browser/src/browser.ts
#	packages/platform-browser/src/security/dom_sanitization_service.ts
#	packages/router/src/config.ts
#	packages/router/src/events.ts
#	packages/router/src/router.ts
#	packages/router/src/router_module.ts
#	packages/router/src/shared.ts
2018-12-29 16:04:37 +08:00
Zhicheng WANG 577a18e2ac fix: 链接错误(#347) 2018-12-20 09:54:34 +08:00
Zhicheng WANG c37a1e55f6 fix: 链接错误 (#347) 2018-12-20 09:28:52 +08:00
Pete Bacon Darwin 18b6d580c5 fix(docs-infra): update overload rendering (#24976)
Based on the review here:
https://github.com/angular/angular/pull/24976#issuecomment-415535125

PR Close #24976
2018-11-01 14:17:11 -07:00
Pete Bacon Darwin 03417df54e build(docs-infra): display long overload parameter types as `object` (#24976)
In some overloads, the parameter type can be a large anonymous
object type.
This change displays such types as `object`. It is then up to the
documentation author to put more information about the type in the
method usage notes.

PR Close #24976
2018-11-01 14:17:11 -07:00
Pete Bacon Darwin 61cd5f7c0f build(docs-infra): fix individual API overload templates (#24976)
* Make individual overloads collapsible
* Show only the first overload expanded, rest collapsed
* Text changes to 'collapse all' once 'show all' is clicked
* Fix chevron/carrot rotation animation when overloads / overload item is expanded or collapsed

PR Close #24976
2018-11-01 14:17:11 -07:00
Pete Bacon Darwin 68dfa04f8a build(docs-infra): add method overload index (#24976)
PR Close #24976
2018-11-01 14:17:10 -07:00
Stefanie Fluin 6902977665 build(docs-infra): improve API overload templates (#24976)
PR Close #24976
2018-11-01 14:17:10 -07:00
Zhicheng Wang 1cf66d57f2 fix: point to angular-cn repo 2018-10-30 10:26:25 +08:00
Pete Bacon Darwin d72d50d83e build(docs-infra): move CLI API desciption higher up (#26568)
Closes #26556

PR Close #26568
2018-10-29 13:01:08 -04:00
Pete Bacon Darwin 07509da78d build(docs-infra): ensure that CLI code blocks are not auto-linked (#26675)
Some of the text in CLI API docs were being auto-linked to API
pages. This was not correct, and in fact these blocks should not
have any auto links to Angular API at all.

Closes #26570

PR Close #26675
2018-10-26 18:09:20 -04:00
Pete Bacon Darwin 9ff8155cd9 build(docs-infra): mark code blocks to disable auto-linking (#26675)
You can now mark `<code>` blocks with a `no-auto-link` css class
to tell the code auto-linker to ignore this code block.

PR Close #26675
2018-10-26 18:09:20 -04:00
Pete Bacon Darwin 7c730fe5b3 build(docs-infra): include inherited members in search index (#26676)
Closes #23800

PR Close #26676
2018-10-26 13:16:33 -04:00
Pete Bacon Darwin f233131974 build(docs-infra): refactor generateKeywords processor (#26676)
PR Close #26676
2018-10-26 13:16:32 -04:00
Zhicheng Wang ea64d68962 docs: 汉化 CLI 模板 2018-10-22 19:55:49 +08:00
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 4bd9f53e8f feat(docs-infra): rename tagdef: `@experimental` to `@publicApi` (#26595)
PR Close #26595
2018-10-19 14:35:52 -07:00
Pete Bacon Darwin 4c0ad5238e build(docs-infra): display github links in CLI API docs (#26515)
This commit includes the following changes:

* CLI version information is read from the CLI package from which
  we read the help files.
* CLI API pages now contain GH links
* line numbers are not shown in GH links, if the doc does not
  have a truthy `startingLine` value. This allows us to remove
  hard coded checks for `guide` pages
* content pages and CLI api docs no longer have a `startingLine`
* the hard-coded `packages` path segment has been removed from
  the templates; instead we now only use the `realProjectRelativePath`.
* the `realProjectRelativePath` has been updated accordingly for API
  and CLI API docs.

PR Close #26515
2018-10-19 11:12:54 -07:00
Pete Bacon Darwin 9e8903ada1 build(docs-infra): show github edit link on CLI overview (#26515)
PR Close #26515
2018-10-19 11:12:53 -07:00
Pete Bacon Darwin b9bd95b3b2 build(docs-infra): break long CLI options onto two lines (#26272)
PR Close #26272
2018-10-19 11:07:30 -07:00
Pete Bacon Darwin 3f89aeb80a build(docs-infra): update CLI option rendering (#26272)
PR Close #26272
2018-10-19 11:07:30 -07:00
Pete Bacon Darwin 6c530d3a85 build(docs-infra): render CLI arguments consistently (#26272)
In the command syntax, arguments are rendered as
`var`s enclosed in angle brackets. So this is now repeated
in the arguments table too.

PR Close #26272
2018-10-19 11:07:30 -07:00
George Kalpakas d9d226087c build(docs-infra): allow `""` as empty region in `{@example}` tags (#26514)
PR Close #26514
2018-10-18 09:54:17 -07:00
George Kalpakas 7bad1d356d build(docs-infra): only render code example content in one place (#26514)
PR Close #26514
2018-10-18 09:54:17 -07:00
George Kalpakas 0add00a743 build(docs-infra): throw error if using `title` on code snippets (#26514)
Since #26396, the `title` property is ignored and `header` should be
used instead for specifying a code snippet's header.

This commit ensures that we don't accidentally set `title` have it be
silently ignored.

PR Close #26514
2018-10-18 09:54:17 -07:00
William Marques fc6dad40ac fix(docs-infra): rename "title" by "header" to avoid unwanted tooltips (#26396)
Closes #26174

PR Close #26396
2018-10-17 11:05:29 -07:00
Pete Bacon Darwin ea20ae63d0 build(docs-infra): only show name in 'inherited from' section (#26387)
Closes #26181

PR Close #26387
2018-10-12 09:13:02 -07:00
George Kalpakas 67608a907e build(docs-infra): make the git ref for cli command docs configurable (#26391)
PR Close #26391
2018-10-11 12:57:49 -07:00
Pete Bacon Darwin 5977b72e9c build(docs-infra): fix formatting of entry point export table (#25768)
Now that `list-table` cells are `pre` formatterd we must be careful
of what whitespace appears in text nodes.

PR Close #25768
2018-10-01 09:36:34 -07:00
Pete Bacon Darwin 7373da9b11 build(docs-infra): simplify property syntax rendering (#25768)
PR Close #25768
2018-10-01 09:36:34 -07:00
Pete Bacon Darwin 783a682a7d build(docs-infra): remove unused property table heading (#25768)
PR Close #25768
2018-10-01 09:36:34 -07:00
Pete Bacon Darwin d22418d417 build(docs-infra): add short description "See more" link (#25768)
If there is additional (non-short) description then add in a
link to the short description to take the reader there.

PR Close #25768
2018-10-01 09:36:34 -07: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 f4b60588fb build(docs-infra): move directive macros into memberHelpers.html (#25768)
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 9889276b15 build(docs-infra): directive inputs and outputs (#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 4b132c9848 build(docs-infra): remove class overview from 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 f29b218060 feat(docs-infra): generate Angular CLI command reference (#25363)
PR Close #25363
2018-09-26 11:24:02 -07:00
Pete Bacon Darwin b8422b41bb build(docs-infra): fail doc-gen if a content rule fails (#26039)
PR Close #26039
2018-09-24 09:11:02 -07:00
Pete Bacon Darwin 8ac4dd6447 build(docs-infra): allow usage notes on decorator option properties (#26039)
PR Close #26039
2018-09-24 09:11:02 -07:00
Pete Bacon Darwin 3808416479 build(docs-infra): remove legacy jsdoc tag processing (#26039)
PR Close #26039
2018-09-24 09:11:02 -07:00