65 Commits

Author SHA1 Message Date
Andrew Overton
4e245ac6dc [Multiple components] Miscellaneous doc updates
This PR closes out all current doc change requests.

Closes https://github.com/material-components/material-components-ios/pull/10181

COPYBARA_INTEGRATE_REVIEW=https://github.com/material-components/material-components-ios/pull/10181 from andrewoverton:dev-docs-03-15-cherry-pick 00414a4f89e39dfc8d47623ee95e0311db1c7ae7
PiperOrigin-RevId: 363178361
2021-03-16 07:30:36 -07:00
Andrew Overton
07c46757cc Replace material.io API doc links with links to the relevant header f…
This PR replaces API links containing "/api-docs/" with links to suitable header files in GitHub because the site previously linked to is being taken down and replaced with something that won't handle API docs.

Closes https://github.com/material-components/material-components-ios/pull/10045

COPYBARA_INTEGRATE_REVIEW=https://github.com/material-components/material-components-ios/pull/10045 from andrewoverton:replace-mio-api-docs-with-github-links 0d6e56cc11d0c147366a4f6cde829d8b51567ecc
PiperOrigin-RevId: 323424362
2020-07-27 13:09:23 -07:00
Randall Li
1eaff651f9 Reran ./scripts/generate_all_readmes (#8557)
Moved changes from https://github.com/material-components/material-components-ios/pull/7360 to the source Readme file

Also some readme files got a minor addition to add `./` in their generation comment
2019-10-11 10:44:43 -04:00
Wenyu Zhang
8735ebb8e8
[Typography] Add doc to explain fallback behavior. (#7493)
This PR is a follow-up to https://github.com/material-components/material-components-ios/pull/7466 to clarify the behavior of the fallback flag.
2019-05-28 14:18:08 -04:00
Wenyu Zhang
59b8de1254
[Typography] Update Dynamic Type section in Typography doc. (#7469)
Add Dynamic Type doc into Typography as a section.
2019-05-24 00:29:28 -04:00
Wenyu Zhang
a74886b91b
[Typography] Split Typography doc into separate md files. (#7435) 2019-05-21 17:04:19 -04:00
featherless
fa155e0d17
[Typography] Add deprecation notice to the MDCTypography APIs and README (#3633)
This adds deprecation notices to the component's README.md and the individual APIs.

Pivotal story: https://www.pivotaltracker.com/story/show/157238605
2018-05-01 22:58:05 -04:00
Adrian Secord
7a7293883f
Remove space after triple-backtick Markdown syntax. (#3577) 2018-04-29 09:00:53 -04:00
Adrian Secord
72045ffd6d
[Docs] Updated known short link destination URLs to use short links. (#3575)
* Updated known shortlink destination URLs to use short links.

* Updated stray links in the CHANGELOG.md.

* Fixed FAB shortlink.

* Applied replacements to everything outside of components/.
2018-04-28 11:27:59 -04:00
ianegordon
49de50edae Consolidate installation requirements in the main README (#2809) 2018-01-05 13:50:38 -05:00
Scott Hyndman
eed028eacb [Docs] Adds API documentation roots and tidies up here and there. (#1425)
* [Docs] Marks component files as API documentation roots.

Used by the site generator to determine where to build API docs. I
marked everything built by the previous version.

* [Docs] Adds a prefix to all Material guidelines links.

* [Docs] Adds API doc links to some components.
2017-05-12 16:03:56 -04:00
Scott Hyndman
1571a1b9ee [Docs] Nests components in the navigation as spec'd. (#1404)
Also took the opportunity to remove an unneeded liquid style
application.
2017-05-09 11:49:44 -04:00
Scott Hyndman
1bec0a903a [Docs] Misc. cleanup (#1403)
* [Docs] Changes an icon list class name.

* [Docs] Adds annotations to all installation code snippets.

* [Docs] Fixes screenshot sizes in PageControl README.

* [Docs] Fixes a broken link on the homepage.

* [Docs] Adds a stable repository branch field to the site metadata.

Used to link to the GitHub source tree.

* [Docs] Specify platform in docs root title.
2017-05-08 18:05:05 -04:00
Randall Li
d7cf7999ed [Buttons, Page Control, Typography] Removed video demos (#1387)
* removed link to videos

* deleted videos
2017-05-05 16:58:17 -04:00
Randall Li
d48a3dae3e [Buttons, Page Control, Typography] Fixed screenshots (#1380)
* Fixed screenshots

* fixed readme.md files for 375 width images instead of 320
2017-05-05 16:37:19 -04:00
Scott Hyndman
4a011e75a5 [Docs] Docstravaganza (#1330)
* [Docs] Adds platform configuration for the doc site.

* [Docs] Adds path metadata for documentation site.

This field is used to determine where the file will appear in the
doc site.

* [Docs] Updates Material guideline links to latest URL.

material.google.com -> material.io/guidelines

* [Docs] Introduces a separate component index for the docsite.

* [Docs] Changes the directory used for site generation.

* [Docs] Moves documentation-site-only Markdown into its own directory.

* [Docs] Changes material.io links to use https.

* [Docs] Renames the howto and contributing docsite sections to docs.

* [Docs] Adds a navTitle field to the collection editing/styling pages.

* [Docs] Changes the FAQ heading to be one size bigger.

* [Docs] Changes the tutorial title.

* [Docs] Adds icons to three more components.

* [Docs] Introduces a root component directory called /catalog/.

* [Docs] Adds an icon to the AnimationTiming component.

* [Docs] Adds an icon for the typography component.

* [Docs] Reformats the docsite index.
2017-05-01 17:27:38 -04:00
Will Larche
3f99ed2dd9 [All] replacing ~~~ with ```. (#1324) 2017-04-17 17:06:37 -04:00
Scott Hyndman
0913aa9aaf [Docs]: Updated link list classes. (#1320)
Link lists now use BEM notation across the board. It's more verbose, but is
aligned with the conventions of MDC-web and the docs site.
2017-04-13 17:25:23 -04:00
Scott Hyndman
69533578ca [docs] Associated icons with components (#1315)
* Adds icon IDs to most component READMEs.

The ones without icon IDs will default to a generic icon.

* Removes a space from front matter.
2017-04-12 18:22:08 -04:00
Scott Hyndman
9ed1d4349d Gigantic documentation update. (#1305)
There are more changes to come, but it's time we merged back.

Changes:
* Re-introduces the doc site scripts and files that had been deleted previously.
* Updates contributing docs to reflect doc structure changes.
* Applies common header structure across all component documentation.
* Fixes a bunch of liquid syntax bugs.
* Inlines Front Matter metadata in README.md files as HTML comments. Any file prefixed with

  <!--docs:
  ...yaml
  -->

  Will be converted into Front Matter when generating the site.
* .jekyll_prefix files, which previously stored the data, have been removed.
2017-04-05 10:53:34 -04:00
Will Larche
a6b23484bd [Typography] Corrects typo in snippet. (#1198) 2017-02-13 16:35:55 -05:00
Justin Shephard
7a19483569 [ReadMes] - First image of each component is too big (#1110)
* MDC_#917 - Activity Indicator Readme Update

* MDC_#917 - Updated remaining readme image links

* MDC_#917 - Fixed typo
2016-12-27 14:16:55 -05:00
Adrian Secord
e8c45d5394 Removed old refs to API docs. (#1084)
* Removed old refs to API docs.

* Removed outdated refs to API docs.
2016-12-15 15:35:13 -05:00
Adrian Secord
03059189e5 Remove all references to removed components (#1067)
* Removed dead components from podspec.

* Removed vestigial refs to removed components.

* Edited refs to MDCFontDiskLoader in Typography README.md.

* Updated Podfile.lock files.
2016-12-14 13:23:37 -05:00
Will Larche
ae163f527c [Readmes] Snippets in Swift 3 (#1050)
* [Typography] Snippets in Swift 3.

* [Snackbar] Snippets in Swift 3.

* [Slider] Snippets in Swift 3.

* [Readmes] Alignment correction.
2016-12-13 23:35:34 -05:00
Adrian Secord
e93a16ca02 Capitalize "Material" in documentation (#1014)
* s/material design/Material Design/g

* s/material components/Material Components/g

* s/material\([ \t\n]\)/Material\1/g

* s/aterial design/aterial Design/g
2016-12-13 08:06:55 -05:00
Randall Li
6834ae3efc [Typography] Removes the runtime inspection that uses Roboto if it can be found (via MDCRobotoFontLoader) (#713)
* [Typography] Removes the runtime inspection that uses Roboto if it can be found (via MDCRobotoFontLoader) (#712)

* [Typography] Removed runtime inspection for MDCRobotoFontLoader and using Roboto if found.

* corrected readme's

* [Typography] Removed runtime inspection for MDCRobotoFontLoader and using Roboto if found.

Summary:
Corrected readme's
Fixed tests

Reviewers: O1 Material components iOS!

Tags: #material_components_ios

Differential Revision: http://codereview.cc/D1672

* Switch to roboto in apppDel

* Removed default clause in Typography readme and added similar clause to RobotoFontLoader warning about font assets being added to your App

* sort imports for appdel

* fix app delegate imports

* removed roboto font loader form app del

* reorder swift objective c examples
2016-12-12 17:51:45 -05:00
Will Larche
1080e89422 [Documentation] Putting Swift snippets before Objc (#960)
* [ActivityIndicator] Swift first in README

* [AnimationTiming] Swift first in readme.

* [AppBar] Swift first in readme.

* [ButtonBar] Swift first in readme.

* [Buttons] Swift first in readme.

* [CollectionLayoutAttributes] Swift first in readme

* [Collections] Swift first in readme.

* [Dialogs] Swift first in readme.

* [FeatureHighlight] Swift first in readme.

* [FlexibleHeader] Swift first in readme.

* [FontDiskLoader] Swift first in readme.

* [HeaderStackView] Swift first in readme.

* [Ink] Swift first in readme.

* [NavigationBar] Swift first in readme.

* [OverlayWindow] Adding missing site comments. Swift first in readme.

* [PageControl] Swift first in readme.

* [Palettes] Swift first in readme.

* [ProgressView] Swift first in readme.

* [RobotoFontLoader] Swift first in readme.

* [ShadowElevations] Swift first in readme.

* [ShadowLayer] Swift first in readme.

* [Slider] Swift first in readme.

* [Snackbar] Swift first in readme.

* [SpritedAnimationView] Swift first in readme.

* [Switch] Swift first in readme.

* [Typography] Swift first in readme.

* [ShadowLayer] Reducing font size in readme.

* [Switch] Reducing font size in readme.
2016-12-07 10:31:34 -05:00
Randall Li
373b94e524 [Typography] Corrected swift import in example and readme. (#919)
* [Typography] Corrected Swift example import

* [Typography] Corrected Swift readme import
2016-12-01 14:25:32 -05:00
Louis Romero
e7198c41e3 Fix the hero video appearance in GitHub. (#916)
* Comment image

* Handle site vs GitHub distinction. Also updates the alt texts to match the component.
2016-12-01 12:52:26 -05:00
Will Larche
5ca7c0bcf8 [Readme] Removing dead link in components. 2016-11-30 13:32:06 -05:00
Adrian Secord
2997e50c4c Updated refs to GitHub repo with new location. (#885)
* Updated refs to GitHub repo with new location.

* Reverted chagnes to JSON files.
2016-11-22 14:32:50 -05:00
randallli
56c220b098 Revert "[Typography] Removes the runtime inspection that uses Roboto if it can be found (via MDCRobotoFontLoader) (#712)"
This reverts commit 6c9c77a0415664854851f6c9c8b808d2d2c58c3d.
2016-09-30 17:44:29 -04:00
Randall Li
6c9c77a041 [Typography] Removes the runtime inspection that uses Roboto if it can be found (via MDCRobotoFontLoader) (#712)
* [Typography] Removed runtime inspection for MDCRobotoFontLoader and using Roboto if found.

* corrected readme's

* [Typography] Removed runtime inspection for MDCRobotoFontLoader and using Roboto if found.

Summary:
Corrected readme's
Fixed tests

Reviewers: O1 Material components iOS!

Tags: #material_components_ios

Differential Revision: http://codereview.cc/D1672

* Switch to roboto in apppDel

* Removed default clause in Typography readme and added similar clause to RobotoFontLoader warning about font assets being added to your App

* sort imports for appdel
2016-09-30 16:36:05 -04:00
Will Larche
32c499aee1 [Typography] Typo in README 2016-08-31 15:44:16 -04:00
Will Larche
7a4c71801f Api docs links were broken in READMEs
Summary:
[Site] Api docs in README files are now explicit.
closes https://github.com/google/material-components-ios/issues/690

Reviewers: O1 Material components iOS, shepj

Reviewed By: O1 Material components iOS, shepj

Tags: #material_components_ios

Differential Revision: http://codereview.cc/D1552
2016-08-29 18:31:23 -04:00
Justin Shephard
f53506ea28 Site_Readme_Links - Added Jekyll conditional with links to site/github documentation
Summary:
Merge branch 'develop' into Site_Readme_Links

Site_Readme_Links - Change of variable name

Site_Readme_Links - Spelling correction on FontDiskLoader

Reviewers: O1 Material components iOS, randallli

Reviewed By: O1 Material components iOS, randallli

Subscribers: randallli

Tags: #material_components_ios

Differential Revision: http://codereview.cc/D1507
2016-08-23 10:54:23 -04:00
Justin Shephard
685ea43198 MDC_#546 - Start of separation of README.md and yaml
Summary: Created separate README.md and README.yaml files to remove the odd display of the md in GitHub.

Reviewers: O1 Material components iOS, ajsecord

Reviewed By: O1 Material components iOS, ajsecord

Tags: #material_components_ios

Differential Revision: http://codereview.cc/D1496
2016-08-18 16:55:20 -04:00
randallli
681cc2b6f7 [Docs] Replaced incorrect name of the product. Material Components *for* iOS
Summary:
s/material components ios/Material Components for iOS/
s/material components for ios/Material Components for iOS/

lint copy edit line length

Reviewers: ajsecord, O1 Material components iOS

Reviewed By: ajsecord, O1 Material components iOS

Subscribers: ajsecord

Tags: #material_components_ios

Differential Revision: http://codereview.cc/D1372
2016-08-01 16:45:12 -07:00
Adrian Secord
65a05eed31 Lowercase "material design" in text.
Summary: "Material design" is not capitalized except when referring to the actual Material Design team at Google.

Reviewers: O1 Material components iOS, randallli

Reviewed By: O1 Material components iOS, randallli

Subscribers: randallli, featherless

Tags: #material_components_ios

Differential Revision: http://codereview.cc/D1306
2016-07-25 14:13:08 -04:00
Adrian Secord
4b3b06d2ce [Website] Added hero videos to component README.md files.
Part of https://github.com/google/material-components-ios/issues/365.

Summary:
Part of https://github.com/google/material-components-ios/issues/365.

Added new files, removed old screenshots and videos.
Updated README.md references to videos/screenshots.

Reviewers: #mdc_ios_owners, junius

Reviewed By: #mdc_ios_owners, junius

Projects: #material_components_ios

Differential Revision: http://codereview.cc/D835
2016-05-05 16:40:48 -04:00
Adrian Secord
f65f9e2ac4 Remove command prompt ('$') from command-line examples so they can be trivially copied and pasted.
Reviewers: #mdc_ios_owners, cjcox

Reviewed By: #mdc_ios_owners, cjcox

Subscribers: cjcox

Projects: #material_components_ios

Differential Revision: http://codereview.cc/D795
2016-04-29 10:56:10 -04:00
Yiran Mao
2b6f7f40a7 Correct links for deploy on various deployment environment.
- Change API reference link to relative link
  - Correct links to other components, all links to other components should end with "/"
  - Update icon-links on home, tutorial and components page
2016-04-26 12:37:06 -04:00
Adrian Secord
ac38382e86 Updated top-level "Documentation" to "Components".
Reviewers: #mdc_ios_owners, randallli

Reviewed By: #mdc_ios_owners, randallli

Projects: #material_components_ios

Differential Revision: http://codereview.cc/D599
2016-04-13 14:48:12 -04:00
Jeff Verkoeyen
06c44a0e47 Addressing linter warnings.
Summary:
Mostly line length warnings.
Also removed the empty PageControlExampleUITests.m.

Reviewers: randallli, #mdc_ios_owners, ajsecord

Reviewed By: randallli, #mdc_ios_owners, ajsecord

Subscribers: ajsecord

Projects: #material_components_ios

Differential Revision: http://codereview.cc/D567
2016-04-12 14:34:23 -04:00
randallli
0e390b59a3 [Typography] fixed links in readme
Reviewers: #mdc_ios_owners, ajsecord

Reviewed By: #mdc_ios_owners, ajsecord

Projects: #material_components_ios

Differential Revision: http://codereview.cc/D561
2016-04-11 17:12:20 -04:00
randallli
2fe58210bb [RobotoFontLoader, FontDiskLoader, Typography] Readme: Added some missing sections and edits.
Summary: more fixes

Reviewers: ajsecord, #mdc_ios_owners

Reviewed By: ajsecord, #mdc_ios_owners

Subscribers: ajsecord

Projects: #material_components_ios

Differential Revision: http://codereview.cc/D551
2016-04-11 14:19:47 -04:00
Yiran Mao
40fb585bb4 [Bug Fix] Correct all api reference links in markdowns
Closes https://github.com/google/material-components-ios/issues/274
2016-04-08 12:33:29 -04:00
Adrian Secord
2acbf968a5 Added import sections for each component.
Summary: Fixes https://github.com/google/material-components-ios/issues/252.

Reviewers: #mdc_ios_owners, featherless

Reviewed By: #mdc_ios_owners, featherless

Subscribers: featherless

Projects: #material_components_ios

Differential Revision: http://codereview.cc/D520
2016-04-07 16:53:58 -04:00
Adrian Secord
7cf9f64cae Changed "$ pod" strings in documentation files.
Fixes #267.

Reviewers: #mdc_ios_owners, featherless

Reviewed By: #mdc_ios_owners, featherless

Projects: #material_components_ios

Differential Revision: http://codereview.cc/D484
2016-04-05 14:46:47 -04:00