From 26aaf69170510ba6538ec6ca2c732e4bf5c2cdcd Mon Sep 17 00:00:00 2001 From: rdlabo Date: Wed, 19 Aug 2026 13:18:45 +0900 Subject: [PATCH 1/2] docs: slim README with omit markers for GitHub-only sections Keep the landing aligned with the docs portal and hide demo/testing notes behind omit comments. --- README.md | 20 +++++++++++++++----- package.json | 3 ++- 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0fa66cb..5bc733d 100644 --- a/README.md +++ b/README.md @@ -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/ @@ -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. @@ -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 @@ -71,6 +72,14 @@ createApp(App) }) ``` + +## Documentation + +Start with [Installation](#installation). Pair this theme with [@rdlabo/ionic-theme-ios26](/ionic-theme-ios26/) when you need both platforms from one markup tree. + + +**Full documentation:** [https://docs.rdlabo.dev/projects/ionic-theme-md3](https://docs.rdlabo.dev/projects/ionic-theme-md3) + ## Development & Testing ### Demo Application @@ -104,3 +113,4 @@ npm run test:e2e:debug # Update baseline screenshots (when intentionally changing UI) npm run test:e2e:update ``` + diff --git a/package.json b/package.json index c58371b..e8758a4 100644 --- a/package.json +++ b/package.json @@ -17,7 +17,8 @@ "files": [ "dist", "src", - "package.json" + "package.json", + "docs" ], "scripts": { "build": "npm run build:css && npm run build:ts", From 4a3e982a9348c059a26a6054e6ead6b5993d084b Mon Sep 17 00:00:00 2001 From: rdlabo Date: Wed, 19 Aug 2026 13:32:28 +0900 Subject: [PATCH 2/2] docs: use a resolvable ios26 docs URL and stop publishing a missing docs/ The previous project-root path 404s on GitHub, and files.docs had no matching directory. --- README.md | 2 +- package.json | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5bc733d..94d4018 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ createApp(App) ## Documentation -Start with [Installation](#installation). Pair this theme with [@rdlabo/ionic-theme-ios26](/ionic-theme-ios26/) when you need both platforms from one markup tree. +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. **Full documentation:** [https://docs.rdlabo.dev/projects/ionic-theme-md3](https://docs.rdlabo.dev/projects/ionic-theme-md3) diff --git a/package.json b/package.json index e8758a4..c58371b 100644 --- a/package.json +++ b/package.json @@ -17,8 +17,7 @@ "files": [ "dist", "src", - "package.json", - "docs" + "package.json" ], "scripts": { "build": "npm run build:css && npm run build:ts",