Context is in the associated issue.
This affects the perl expression that prepends `docs/` to local urls. Specifically, it makes the perl expression only modify urls that link to a sibling markdown file composed of `\w` characters (e.g. `theming.md`). This is not perfect, but it addresses our needs for now. If/when we encounter other types of local urls that we can address them separately.
For now, this change fixes the incorrect behavior described in the associated bug.
Closes https://github.com/material-components/material-components-ios/issues/7203
## Related links
* Related bug: #5772
* Blocking PR: #6460
## Introduction
The team has decided to pivot to theming extensions instead of _Themer_ objects. As we pivot we need to document how these new extensions work, for clients to use them. This adds documentation for buttons with the new theming extensions.
_Note_ This is blocked by #6460 until that is resolved and merged then some of these links will not work.
## The problem
We don't have documentation on theming extensions for buttons.
## The fix
Add theming extension documentation for clients to see how we intend for them to use our new theming extensions within the button component.
## Remaining work
- [x] Add documentation for container scheme
- [ ] README updates for Buttons using Material Theming Extensions
- [x] README updates for Dialogs using Material Theming Extensions
{MDC iOS} No longer using `-init` for Color Scheme.
Based on the discussions in go/mdc-ios-theming, we should not use the `-init` default initializer. Instead, we should use an explicit set of defaults.
Search regex: '\[\[MDCSemanticColorScheme alloc\] init\]'
This PR adds the shape theming API documentation using the doc generation script improvements that were added in PR #5463 .
To achieve this, I added into the .vars files of the supported components the missing variables, and ran the script `scripts/apply_all_templates`. Then I ran `scripts/generate_readme component` for the components that have been added the `shape-theming.md` file, so it is seen in the actual README.md of the component.
Specifically, Bottom Sheet was using the old method of documentation, and wasn't using the right generation method, so it's doc content was just copied to the right location to allow its generation to work well as well.
Closes#5319
As part of our readme generator, components can now opt in to displaying badges in their readme.
The badges are generated from https://shields.io/ and are focused on an individual component. We're currently generating the following badges:
- Open bug count.
This discourages depending on all of a component's extensions and aligns our targets more closely with how we expect them to be imported and depended upon.
This is a breaking change.
Pivotal story: https://www.pivotaltracker.com/story/show/157118721
* 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/.
* [Buttons] Remove .largeIcon shape from FloatingButton (#2513)
The LargeIcon shape is not required, since the same behavior (support
for 36-point images) can be achieved by setting the contentEdgeInsets to
.zero.
Also updates one of the button examples to use a 36-point icon.
* [Buttons] Add extended FAB layout code (#2528)
Creating (internal for now) the required properties and layout code to support
the extended FAB. Unit tests to confirm the behavior and some minor
adjustments to existing values like default contentEdgeInsets values.
Implements #2495
* [Buttons] Expose Extended FAB properties (#2543)
Making the new properties public and also migrating away from simple
property setters to the new forShape:inMode: setters required for
UIAppearance support.
* minimumSize
* maximumSize
* contentEdgeInsets
* hitAreaInsets
Implements #2495
* [Buttons] Add basic Floating Button example (#2554)
Includes automatic adjustment of extended/normal layout depending on size
classes.
Demonstrates #2495
* [Buttons] Update README for Extended FAB (#2561)
The README includes usage examples for the FAB. Adding a section to
demonstrate how to configure the FAB in its different shapes and modes.
Documents #2495
* [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.
* [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.
* [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.
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.
* [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.
* [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.
