77d24afea3
build(aio): improve rendering of directive selectors
2017-09-12 13:55:54 -04:00
39386eadea
build(aio): do not render comments in decorators
...
Closes #18873
2017-09-12 13:52:02 -04:00
bd928f3dcc
build(aio): render metadata members from decorator ancestors
2017-09-08 17:04:36 -04:00
e78402dd4c
build(aio): render ancestor members in directives
...
See `CheckBoxRequiredValidator` for an example.
2017-09-08 17:04:28 -04:00
917d0870e8
build(aio): don't show constructor detail if there is none
2017-09-08 13:21:16 -04:00
3c480e4e63
build(aio): support rendering of constructor overloads in API docs ( #19042 )
...
Closes #18258
2017-09-06 10:14:02 -07:00
35bc1eb218
build(aio): render the `extends` ancestors of classes in API docs ( #18927 )
...
PR Close #18927
2017-09-05 15:33:10 -05:00
dc7de0896c
build(aio): ensure dgeni can load all angular Typescript modules ( #18927 )
...
PR Close #18927
2017-09-05 15:33:10 -05:00
de34171fa2
Merge remote-tracking branch 'origin/master' into aio
...
# Conflicts:
# aio/content/guide/aot-compiler.md
# aio/content/guide/change-log.md
# aio/content/guide/ts-to-js.md
# aio/content/marketing/docs.md
# aio/content/navigation.json
# aio/src/app/documents/document.service.ts
2017-08-20 19:39:38 +08:00
b8a3736275
build(aio): do not auto-link code elements already inside a link ( #18776 )
...
Closes #18769
PR Close #18776
2017-08-18 17:13:16 -05:00
a6df16f891
Merge branch 'master' into aio
...
# Conflicts:
# aio/content/guide/form-validation.md
# aio/content/guide/i18n.md
# aio/content/guide/reactive-forms.md
# aio/content/marketing/index.html
# aio/content/navigation.json
# aio/src/environments/environment.stable.ts
2017-08-08 13:10:17 +08:00
104edf62f0
fix: minor improvement
2017-08-06 13:49:04 +08:00
de6cfeeee3
clean: remove useless codes
2017-08-06 13:42:51 +08:00
0eaf9156de
fix: use new translation logic
2017-08-06 13:37:25 +08:00
cc2a4c41f9
build(aio): fix warning about missing `<h1>`
...
Fixes #17549
2017-07-31 13:40:07 -07:00
f7b656443d
fix: limit tagName to whole world
2017-07-30 16:23:26 +08:00
3fe722490a
fix: don't hide translation-origin if there is not translation-result
...
fix: translate more.
2017-07-30 14:10:08 +08:00
747ea2a287
fix: retranslate navigation
2017-07-30 13:35:27 +08:00
c002fddabe
fix: many of broken links
2017-07-30 12:32:56 +08:00
f2059b445c
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.md
# aio/content/guide/attribute-directives.md
# aio/content/guide/bootstrapping.md
# aio/content/guide/browser-support.md
# aio/content/guide/cb-index.md
# aio/content/guide/change-log.md
# aio/content/guide/cheatsheet.md
# aio/content/guide/cli-quickstart.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.md
# aio/content/guide/deployment.md
# aio/content/guide/displaying-data.md
# aio/content/guide/dynamic-component-loader.md
# aio/content/guide/dynamic-form.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/index.md
# aio/content/guide/learning-angular.md
# aio/content/guide/lifecycle-hooks.md
# aio/content/guide/ngmodule-faq.md
# aio/content/guide/ngmodule.md
# aio/content/guide/npm-packages.md
# aio/content/guide/pipes.md
# aio/content/guide/quickstart.md
# aio/content/guide/reactive-forms.md
# aio/content/guide/router.md
# aio/content/guide/security.md
# aio/content/guide/server-communication.md
# aio/content/guide/set-document-title.md
# aio/content/guide/setup-systemjs-anatomy.md
# aio/content/guide/setup.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/ts-to-js.md
# aio/content/guide/typescript-configuration.md
# aio/content/guide/upgrade.md
# aio/content/guide/user-input.md
# aio/content/guide/visual-studio-2015.md
# aio/content/guide/webpack.md
# aio/content/navigation.json
# aio/content/tutorial/index.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/package.json
# aio/src/styles/main.scss
# aio/transforms/angular.io-package/index.js
2017-07-30 00:09:50 +08:00
d71ae278ef
fix(aio): fix links to source for paths with symlinks
...
Fixes #18353
2017-07-28 15:28:59 -07:00
36faba1aab
fix(aio): add quote to module
2017-07-18 17:48:04 +01:00
c453b7bcfa
build(aio): fail doc-gen if referenced images are missing
2017-07-18 11:45:05 +01:00
758848961e
build(aio): abort doc-gen on dangling links
2017-07-18 11:45:05 +01:00
99b666614d
build(aio): abort doc-gen if an example is missing
...
Closes #16936
2017-07-18 11:45:05 +01:00
0bf0c35bca
build(aio): render type parameters of API function exports
...
Fixes #18123
2017-07-15 08:52:35 +01:00
db96c963a8
fix(aio): add <hr> in between overloads
2017-07-13 14:58:33 -07:00
ffda3e41e0
build(aio): simplify the primary overload's anchor
...
The primary link to a member should simply be its name, and not require
the parameter list.
2017-07-13 12:16:20 -07:00
a301dba68f
build(aio): improve API docs layout and styling
2017-07-13 12:16:20 -07:00
04f3a4a7a5
build(aio): fix githubLinks line numbers
...
The API docs have changed. The line numbers are now found in
`startingLine` and `endingLine` properties rather than the `location`
property, which moved into the `fileInfo` property anyway.
2017-07-13 12:16:20 -07:00
f06ce9adc8
build(aio): truncate API overview parameters at one line
2017-07-13 12:16:20 -07:00
be3352a084
build(aio): render grouped overloads
2017-07-13 12:16:20 -07:00
998049ec9b
build(aio): truncate API overview parameters at one line
2017-07-13 12:16:20 -07:00
e8bbf86e66
build(aio): add terms from heading to the search index
2017-07-11 15:04:37 +01:00
3a0886dc12
build(aio): capture all the headings from a doc in the vFile.headings property
2017-07-11 15:04:37 +01:00
d52ab8e2c9
build(aio): fix matchUpDirectiveDecorators processor
2017-07-11 11:44:05 +01:00
df7b875f6c
build(aio): fix mergeDecoratorDocs processor
2017-07-11 11:44:05 +01:00
470a7c6bcd
build(aio): use dedicated overview for decorator API docs
2017-07-11 11:44:05 +01:00
3abf208235
build(aio): update doc-gen templates
2017-07-11 11:44:05 +01:00
92c18d167e
build(aio): fix mergeDecoratorDocs processor
2017-07-11 11:44:05 +01:00
99b38f52cb
build(aio): fix matchUpDirectiveDecorators processor
2017-07-11 11:44:05 +01:00
633ec30291
build(aio): fix test description
2017-07-11 11:44:05 +01:00
57cfcb0830
build(aio): refactor filterMemberDocs to be more general
...
Now it also filters function-overloads, hence the name change.
2017-07-11 11:44:05 +01:00
b3d90365b6
fix(aio): add new common/http package into API list
2017-07-10 12:23:47 +01:00
c723d42d0a
refactor: fix typos ( #18000 )
2017-07-07 16:55:17 -07:00
1d93cf2e85
build(aio): ensure all doc tests are run
...
It is not possible to run all the docs tests directly via the jasmine CLI.
Instead we now have a small script that will run jasmine via its library.
2017-06-21 13:51:15 -07:00
3fb98fe4ea
build(aio): do not recurse node_modules when loading examples in doc-gen
2017-06-21 13:51:15 -07:00
12452d4ab4
build(aio): increase docs integration test timeouts
...
The API docs tests have very variable run times, depending
upon the build environment.
This change doubles their test timeout values to prevent
false-negative failures.
2017-06-13 11:56:45 +01:00
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
3db6b6ca7a
build(aio): ignore example files that are gitignored
...
Rather than hard coding excludes into the dgeni config,
use the fact that we are already ignoring the boilerplate
and generated files via the .gitignore file.
2017-06-09 14:33:21 +01:00
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
cb2cb7c3bd
build(aio): display "call" and "new" members of interfaces in API docs
2017-05-31 08:45:50 +03:00
dfbbbb5e3e
build(aio): the the captured h1 as the title for the search index
...
If there is no title already provided, use the one captured from the renderedContent.
2017-05-31 08:45:31 +03:00
89f317915d
build(aio): use the captured h1 as the title if necessary
...
If the doc does not already have a `title` tag
then use the one captured from the renderedContent in
the final JSON output, instead.
2017-05-31 08:45:31 +03:00
4d5fa5c855
build(aio): capture the h1 title and attach it to the document
...
The HTML post-processing now collects any h1
that is found in the renderedContent and attaches
it to the doc via the `doc.vFile.title` property.
2017-05-31 08:45:31 +03:00
b0c5018c70
build(aio): better error message for invalid links ( #16993 )
2017-05-24 11:59:06 -06:00
af99cf2a41
build(aio): compute `{@link ...} titles more effectively ( #16813 )
...
If a usage of `{@link ...}` does not provide a title then
compute it based on the `title` and/or `name` properties
or set the link to invalid.
Closes #16811
2017-05-16 10:21:31 -07:00
a9d9aa18a0
build(aio): automatically link code blocks to API docs
2017-05-15 10:56:38 +01:00
2eca6e67e1
test(aio): add tests for renderAttributes helper
2017-05-11 10:30:10 +01:00
bcbee13e26
build(aio): fail build if more than h1 is found in a doc
...
Closes #16193
2017-05-11 08:15:19 +01:00
56833a6171
docs(aio): more content fixes
2017-05-10 12:51:01 +01:00
f5335d17ec
build(aio): fail the doc-gen if there is an invalid `{@link ...}` tag
...
This fail behaviour is only turned on for `yarn docs`;
in `yarn docs-watch` you only receive a warning.
This is because you can get false errors when watching
since we don't parse all the docs in that case.
2017-05-10 11:39:07 +01:00
9e661e58d1
docs(aio): image sweep ( #16609 )
...
* fix(aio): allow code blocks to clear floated images
Previously the negative margin on the code headings were causing
floated images to overlay the start of a code block. Now all code block
successfully clear all floated elements.
* feat(aio): add a `.clear` class for clearing floating images
* fix(aio): tidy up image styles
The css rules for `img.right` and `img.left` allow authors easy
access to floating an image on the left or right, respectively.
The `.image-display` rule which was always found on a figure
has been simplified so that all figures have this styling. It is very
unlikely that a figure will be used outside the content area; and
at this time it seems like `figure` is as good an indicator that we
want this kind of styling as anything.
Now that images are all tagged with width and height values, we cannot
assume to modify these dimensions via CSS as it can cause the image to
lose its correct proportions. Until we find a better solition we must set
`height` to `auto` when the screen width is below 1300px to ensure that
these images maintain their proportions as they get shrunk to fit.
* docs(aio): general tidy up of image HTML in guides
Previously, the guides have a lot of inline image styling and unnecessary
use of the `image-display` css class.
Images over 700px are problematic for guide docs, so those have been given
specific widths and associated heights.
* docs(aio): use correct anchor for "back to the top" link
The `#toc` anchor does not work when the page is
wide enough that the TOC is floating to the side.
* build(aio): add `#top-of-page` to path variants for link checking
Since the `#top-of-page` is outside the rendered docs
the `checkAnchorLinks` processor doesn't find them
as valid targets for links.
Adding them as a `pathVariant` solves this problem
but will still catch links to docs that do not actually exist.
* fix(aio): ensure that headings clear floated images
* fix(aio): do not force live-example embedded image to 100% size
This made them look too big, generally. Leaving them with no size means
that they will look reasonable in large viewports and switch to 100% width
in narrow viewports.
2017-05-09 15:53:32 -07:00
7b4a8d53a7
build(aio): remove "pure" property from pipe template ( #16655 )
...
This information is not relevant to users, right now.
Closes #16641
2017-05-09 15:44:10 -07:00
0190df9cf3
build(aio): local assets are not dangling links
...
Closes #16615
Closes #16616
2017-05-09 14:33:40 +01:00
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
5057e16874
build(aio): throw an error if a code-example tag is not closed
2017-05-04 15:52:17 -07:00
4dabec6a48
build(aio): compute search title for certain API docs
2017-05-04 13:45:04 +01:00
978376a46e
build(aio): `doc.searchTitle` can override name in search results
2017-05-04 13:45:04 +01:00
5b96fb9320
build(aio): rename `src/content` to `src/generated`
...
This commit will definitely require a clean up of your
working folder:
```
cd aio
git clean -xdf
yarn setup
```
2017-05-03 13:40:46 -07:00
8760bf7be4
build(aio): fix paths to template macros in overview-dump template
2017-05-03 13:30:11 -07:00
ea02073c84
build(aio): mark API docs as not having a TOC
2017-05-03 13:30:11 -07:00
b051d7ff48
build(aio): refactor API templates for clean start
2017-05-03 13:30:11 -07:00
3f1d7f7a76
build(aio): add the api folder to the list of template folders
2017-05-03 13:30:11 -07:00
04dc24820d
feat(aio): comment cleanup, API table styles
...
- API table styling
- Cleanup on resource page comments
2017-05-02 10:57:54 -07:00
3b80472bad
style(aio): fix comment on postProcessHtml processor
...
Fixes https://github.com/angular/angular/pull/16336#discussion_r113891332
2017-05-01 15:52:51 -07:00
ca17d4f639
build(aio): auto-fill width/height to all image tags
...
Parse all `<img>` tags, during doc-gen, and insert the width and height of
the sourceed image, if neither are already specified.
Warnings are reported if the `<img>` tag has no `src` attribute or the image
cannot be loaded.
The work is done in the `addImageDimensions` post-processor, which must be
configured with a `basePath` so that it knows where to find the images.
Closes #15888
2017-05-01 15:52:51 -07:00
64335d3521
build(aio): capture and log errors and warnings when post-processing HTML
2017-05-01 15:52:51 -07:00
9945ce2259
build(aio): move copyContentAssets processor to the base package
...
This allows other processors who need to know about the copyContentAssets
processors to ensure that the runs after the content has been copied.
2017-05-01 15:52:51 -07:00
6d9da73090
build(aio): move attribute utils to helpers folder
...
This allows these utility functions to be reused across packages.
2017-05-01 15:52:51 -07:00
c889fb1ef5
build(aio): include new packages in docs-watch
2017-05-01 15:52:51 -07:00
235eb17cca
build(aio): improve info-bar template
...
The "npm module" and "NgModule" are now rendered correctly.
Closes #16055
2017-05-01 15:51:03 -07:00
f32bfcdbe5
build(aio): convert triple backtick blocks to `code-example` tags
...
Closes #16246
2017-04-30 09:07:28 -07:00
24b9067047
build(aio): remove unused `{@exampleTabs}` inline tag
2017-04-30 09:07:28 -07:00
7b94f493b9
feat(aio): code snippet source available & shown when code missing
...
Tells reader (usually the author) what code file is missing
Also when no linenums specified, turn them on if num of lines > 10
2017-04-28 11:07:45 +01:00
4be1966a21
feat(aio): revise Docs page; docs version selector in sidenav
2017-04-28 09:40:39 +01:00
de25cfc0cb
build(aio): move autolink-headings to post-processing ( #16336 )
...
The autolinking is now done on the `renderedContent` which means it also
captures and autolinks headings that were generated outside of markdown.
PR Close #16336
2017-04-27 23:42:04 -05:00
1ceb2f9c79
build(aio): add new post-process dgeni package
...
This package will allow us to do complex post-processing
on the HTML that is rendered by Nunjucks.
2017-04-27 23:42:04 -05:00
bb52e22ecf
feat(aio): api pages styling
...
- Banner class code consolidation for API pages
- Set up temporary table of contents class and file
- API pages title styling
- Add color styling to doc-type listed on each API details page
- Classes and SCSS variables refactor
- Mobile optimization on headers, info-banner, and API pages
- API page table custom styling
- API Class Overview template code overview into table format
2017-04-26 14:31:54 +01:00
5331fc1aab
build(aio): turn on dangling link checking
2017-04-25 14:09:08 +01:00
1762047bc0
build(aio): fix other dgeni templates
...
The function and interface templates were overriding the
wrong block.
2017-04-25 07:35:34 +01:00
9a4c8d543d
build(aio): fix rendering of Decorator API docs
...
The templates were a bit out and we were not merging the
correct properties.
Added some docs and tests for the processor.
Related to #16208
2017-04-25 07:35:34 +01:00
f5aaa55f21
build(aio): ignore the VERSION constant correctly
...
We were filtering this document from the docs list but
not removing it from the module export lists.
We can actually filter it out much easier at the TypeScript
parsing point, which means we do not need the
`filterIgnoredDocs` processor any more.
Closes #16287
2017-04-25 07:33:50 +01:00
ff0f53c915
build(aio): include missing packages in the docs
...
These packages were not included in the configuration of the doc-gen, so
were not being rendered.
2017-04-25 06:56:41 +01:00
64ef69fb34
feat(aio): api page column layout
2017-04-25 06:51:04 +01:00
3cad5da5a4
build(aio): refactor dgeni packages
...
This is to tidy up the `author-packagse`, which currently duplicates a
lot of the configuration in the main packages. We need to
DRY this up so that we don't fall foul of a change in one being missed in
the other.
2017-04-23 22:50:33 +01:00
cf034f759a
feat(aio): api page styles
...
Changed description from h3 to h2 to match the other header
Created api page classes for consistent styling
Add styles for info-bar section
Wrapped pre tags for code not to go off of screen
2017-04-21 16:24:37 +01:00
9730351048
build(aio): compute which examples to include when watching guide docs ( #16213 )
...
PR Close #16213
2017-04-20 22:16:21 -05:00
ce687550ae
build(aio): run `docs` before `docs-watch` ( #16213 )
...
This helps to ensure that the full docs have been
generated before we begin watching.
You can disable this by providing the `--watch-only`
flag. E.g. `yarn docs-watch -- --watch-only`.
2017-04-20 22:16:16 -05:00
563b909279
build(aio): give the authors-package tests long enough not to flake ( #16213 )
2017-04-20 22:16:10 -05:00
Peter Bacon Darwin
Zhicheng Wang
Georgios Kalpakas
Zhicheng Wang
WilliamKoza
Alex Rickabaugh
Suguru Inatomi
Victor Berchet
Jesus Rodriguez
Stefanie Fluin
Ward Bell