Skip to content

docs: slim README with omit markers for GitHub-only sections #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rdlabo merged 2 commits into from
Aug 19, 2026
Merged

docs: slim README with omit markers for GitHub-only sections #11

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26aaf69
docs: slim README with omit markers for GitHub-only sections
rdlabo Aug 19, 2026
4a3e982
docs: use a resolvable ios26 docs URL and stop publishing a missing d…
rdlabo Aug 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

A CSS/JS theme library that applies Material Design 3 design system to Ionic applications.

**Documentation:** [Read the full documentation](https://docs.rdlabo.dev/projects/ionic-theme-md3)

![](screenshots/md3.png)
![Material Design 3 themed Ionic screens with updated components and navigation](https://raw.githubusercontent.com/rdlabo-dev/ionic-theme-md3/v1.1.0/screenshots/md3.png)

DEMO is here: https://ionic-theme-md3.netlify.app/

Expand All @@ -27,7 +25,11 @@ If you need a more comprehensive Material Design 3 implementation, you may also
> **Note:** This theme is purpose-built for compatibility with Ionic's design approach and `@rdlabo/ionic-theme-ios26`; it is not intended as a strict, full MD3 recreation.


## Setup
## Quick start

After [Installation](#installation), import the theme CSS and set `navAnimation` as shown below.

## Installation

This is a CSS theme for extending your Ionic project. It does not work on its own, so use it together with the Ionic Framework.

Expand All @@ -44,7 +46,6 @@ And import the theme in your project's main CSS file (e.g., `src/styles.scss`).
@import '@rdlabo/ionic-theme-md3/dist/css/ionic-theme-md3.css';
```


Next, configure the animations for MD3. Add the following to your Ionic configuration options.

```ts
Expand All @@ -71,6 +72,14 @@ createApp(App)
})
```


## Documentation

Start with [Installation](#installation). Pair this theme with [@rdlabo/ionic-theme-ios26](https://docs.rdlabo.dev/projects/ionic-theme-ios26) when you need both platforms from one markup tree.

<!-- rdlabo-docs-omit -->
**Full documentation:** [https://docs.rdlabo.dev/projects/ionic-theme-md3](https://docs.rdlabo.dev/projects/ionic-theme-md3)

## Development & Testing

### Demo Application
Expand Down Expand Up @@ -104,3 +113,4 @@ npm run test:e2e:debug
# Update baseline screenshots (when intentionally changing UI)
npm run test:e2e:update
```
<!-- /rdlabo-docs-omit -->
Loading