47 Commits

Author SHA1 Message Date
Nobody
39911e5e75 [Material-iOS/FeatureHighlight, Material-iOS/FlexibleHeader, Material-iOS/HeaderStackView, Material-iOS/PageControl, Material-iOS/ShadowElevation] Fix broken images in iOS/Supporting APIs dev docs
PiperOrigin-RevId: 368295102
2021-04-13 14:30:45 -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
Andrew Overton
0a36a3a12b [MDC-iOS] Fix broken links
This CL fixes some longstanding and some newly broken links.

PiperOrigin-RevId: 311351416
2020-05-13 10:09:44 -07:00
Andrew Overton
7814b0c460 Replace App Bar docs
This PR replaces the AppBar README. The content is mostly the same, I just had to restructure it in order to fit the new template.

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

PiperOrigin-RevId: 309097690
2020-04-29 14:32:52 -07:00
Andrew Overton
53dfaa3e48
Remove "+Extensions" pod installation instructions from component readmes (#5080)
Several Readmes were not updated to reflect the removal of the "+Extensions" subspecs in MaterialComponents.podspec. This PR removes them.

Closes #5067
2018-09-11 10:08:56 -04:00
Jeff Verkoeyen
ead0ae4936 Fix ordering of header stack view and navigation bar intro text. 2018-05-03 16:49:17 -04:00
featherless
a078a9722d
Standardize the casing for all components to match spec. (#3693) 2018-05-03 15:02:36 -04:00
featherless
c541893c30
[AppBar] Nest all of the implementation detail components under AppBar.
This nests HeaderStackView and NavigationBar under AppBar in the docs.

Pivotal story: https://www.pivotaltracker.com/story/show/157205667
2018-05-01 23:11:20 -04:00
featherless
e76147d8cd
[HeaderStackView] Remove color theming docs and mark the color themer as to be deprecated. (#3612) 2018-05-01 16:07:30 -04:00
Adrian Secord
7a7293883f
Remove space after triple-backtick Markdown syntax. (#3577) 2018-04-29 09:00:53 -04:00
featherless
d3c5316db0 Generate all themer documentation. (#3562)
* Generate all themer documentation.

* Fix Snackbar vars.

* Fix textfields vars.

* Fix link.

* Fix bottom app bar vars.

* Fix more vars.

* Add home page links.

* Fix typos.

* Fix more links.

* Add ink.

* Tabs.

* Cleanup.
2018-04-27 16:59:03 -04:00
ianegordon
49de50edae Consolidate installation requirements in the main README (#2809) 2018-01-05 13:50:38 -05:00
Yarden Eitan
6df22d2cd6
Update MaterialComponents podspec to separate extensions from component. Breaking change, please see description when sending out a new release (#2748)
* [Catalog] Update catalog readme to reflect podspec filename change

* upate podspec

* update spec to extension

* more specific dependency

* added documentation
2018-01-02 16:51:58 -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
Justin Shephard
ebcb49dc14 [HeaderStack] - Remove video from Readme (#1391)
* [HeaderStack] - Remove video from Readme

* [HeaderStackView] - Remove if in Readme

* [HeaderStackView] - Remove video file
2017-05-05 17:22:44 -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
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
Will Larche
3c4e905598 [Readmes] Snippets in Swift 3 (#1039)
* [ActivityIndicator] Snippets in Swift 3

* [AnimationTiming] Snippets in Swift 3.

* [AppBar] Snippets in Swift 3 and corrections to snippets.

* [ButtonBar] Snippets in Swift 3 and corrections to snippets.

* [ButtonBar] Removing TODO.

* [Buttons] Snippets in Swift 3.

* [Collections] Snippets in Swift 3 and snippet corrections.

* [CollectionLayoutAttributes] Snippets in Swift 3.

* [Dialogs] Snippets in Swift 3 and snippets corrections.

* [FeatureHighlight] Snippets in Swift 3 and snippets corrections.

* [FeatureHighlight] Missing import specification.

* [FlexibleHeader] Snippets in Swift 3 and snippet corrections.

* [Dialogs] Corrections to snippets.

* [HeaderStackView] Adding import specifier.

* [Ink] Snippets in Swift 3 and snippets corrections.

* [NavigationBar] Snippets in Swift 3.

* [NavigationBar] Removing TODO.

* [OverlayWindow] Snippets in Swift 3 and snippets corrections.

* [PageControl] Snippets in Swift 3 and snippet corrections.

* [OverlayWindow] Snippets in Swift 3 and snippet corrections.

* [Palettes] Snippets in Swift 3 and snippet corrections..

* [ProgressView] Snippets in Swift 3 and snippet corrections.

* [Readmes] Snippet alignment corrections.
2016-12-13 17:17:57 -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
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
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
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
randallli
06df37a74d [HeaderStackView] added missing swift code snippet to readme.
Summary:
Also added clarification to overview.

ongoing work for https://github.com/google/material-components-ios/issues/318

Reviewers: featherless, #mdc_ios_owners

Reviewed By: featherless, #mdc_ios_owners

Projects: #material_components_ios

Differential Revision: http://codereview.cc/D715
2016-04-22 10:34:28 -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
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
Jeff Verkoeyen
18434799b3 Ran arc lint --everything --apply-patches
Summary: All changes are auto-generated.

Reviewers: #mdc_ios_owners, ajsecord

Reviewed By: #mdc_ios_owners, ajsecord

Projects: #material_components_ios

Differential Revision: http://codereview.cc/D474
2016-04-05 10:48:48 -04:00
Jeff Verkoeyen
be002a2f9f [HeaderStackView] Fleshing out the README.md.
Reviewers: #mdc_ios_owners, randallli

Reviewed By: #mdc_ios_owners, randallli

Projects: #material_components_ios

Differential Revision: http://codereview.cc/D440
2016-03-31 14:15:25 -04:00
Jason Striegel
be5ecec266 Adding excerpts to component docs metadata. 2016-03-30 15:28:46 -04:00
Jason Striegel
38ef5d4784 Including component README screenshots. 2016-03-29 17:09:28 -04:00
Jason Striegel
117f16d744 Bash example consistency pass. 2016-03-24 18:06:10 -04:00
Jason Striegel
ec30977f4b Updates to top links and markdown formatting. 2016-03-23 17:37:16 -04:00
Jeff Verkoeyen
eeb5990e43 Add HeaderStackView README.
Reviewers: #mdc_ios_owners, ajsecord

Reviewed By: #mdc_ios_owners, ajsecord

Subscribers: ajsecord

Projects: #material_components_ios

Differential Revision: http://codereview.cc/D270
2016-03-16 10:58:16 -04:00