Skip to content

Commit cbb59c2

Browse files
authored
Merge pull request #28 from MobileReality/chore/updated-docs
Chore/updated docs
2 parents cb96772 + 37ec5e0 commit cbb59c2

35 files changed

Lines changed: 2287 additions & 73 deletions

.changeset/silent-tires-shave.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@mobile-reality/mdma-demo": patch
3+
---
4+
5+
Add SVG logo with gradient hexagon symbol and vector MDMA text; integrate logo into top nav header and favicon; update README with new logo, mdma-3.gif, and Docs link alongside Live Demo

.github/workflows/ci.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ jobs:
1414
build:
1515
runs-on: ubuntu-latest
1616
steps:
17-
- uses: actions/checkout@v6
17+
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
1818

19-
- uses: pnpm/action-setup@v5
19+
- uses: pnpm/action-setup@a8198c4bff370c8506180b035930dea56dbd5288 # v5
2020

21-
- uses: actions/setup-node@v6
21+
- uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6
2222
with:
2323
node-version: 22
2424
cache: pnpm

.github/workflows/deploy-demo.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ jobs:
2222
build:
2323
runs-on: ubuntu-latest
2424
steps:
25-
- uses: actions/checkout@v4
25+
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
2626

27-
- uses: pnpm/action-setup@v4
27+
- uses: pnpm/action-setup@f40ffcd9367d9f12939873eb1018b921a783ffaa # v4
2828

29-
- uses: actions/setup-node@v4
29+
- uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
3030
with:
3131
node-version: 22
3232
cache: pnpm
@@ -37,7 +37,7 @@ jobs:
3737
- name: Build packages and demo
3838
run: pnpm --filter @mobile-reality/mdma-demo... build
3939

40-
- uses: actions/upload-pages-artifact@v3
40+
- uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
4141
with:
4242
path: demo/dist
4343

@@ -48,5 +48,5 @@ jobs:
4848
name: github-pages
4949
url: ${{ steps.deployment.outputs.page_url }}
5050
steps:
51-
- uses: actions/deploy-pages@v4
51+
- uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4
5252
id: deployment

.github/workflows/release.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ jobs:
1414
packages: write
1515
pull-requests: write
1616
steps:
17-
- uses: actions/checkout@v6
17+
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
1818

19-
- uses: pnpm/action-setup@v5
19+
- uses: pnpm/action-setup@a8198c4bff370c8506180b035930dea56dbd5288 # v5
2020

21-
- uses: actions/setup-node@v6
21+
- uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6
2222
with:
2323
node-version: 22
2424
cache: pnpm
@@ -28,7 +28,7 @@ jobs:
2828
- run: pnpm build
2929

3030
- name: Create Release Pull Request or Publish
31-
uses: changesets/action@v1
31+
uses: changesets/action@63a615b9cd06ba9a3e6d13796c7fbcb080a60a0b # v1.8.0
3232
with:
3333
publish: pnpm release
3434
env:

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
<p align="center">
2-
<img src="assets/logo.png" alt="MDMA Logo" width="600" />
2+
<img src="assets/logo.svg" alt="MDMA Logo" width="160" />
33
</p>
44

55
<h1 align="center">MDMA</h1>
66
<p align="center">Markdown Document with Mounted Applications</p>
77
<p align="center">Interactive documents from Markdown. Built for next gen-apps</p>
8-
<p align="center"><a href="https://mobilereality.github.io/mdma/">🚀 Live Demo</a></p>
8+
<p align="center">
9+
<a href="https://mobilereality.github.io/mdma/">🚀 Live Demo</a>
10+
&nbsp;&nbsp;·&nbsp;&nbsp;
11+
<a href="https://mobilereality.github.io/mdma/#/docs">📖 Docs</a>
12+
</p>
913

1014

1115
## Why MDMA?
@@ -15,7 +19,7 @@ AI conversations today are plain text — the user reads a response and manually
1519
No custom UI per use case. No parsing free-form text. The AI generates structured, validated components and your frontend renders them instantly.
1620

1721
<p align="center">
18-
<img src="assets/mdma-2.gif" alt="MDMA Demo" width="800" />
22+
<img src="assets/mdma-3.gif" alt="MDMA Demo" width="800" />
1923
</p>
2024

2125
## What is MDMA?

assets/logo.svg

Lines changed: 28 additions & 0 deletions
Loading

assets/mdma-3.gif

6.39 MB
Loading

demo/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
<head>
44
<meta charset="UTF-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<link rel="icon" type="image/svg+xml" href="/mdma/logo.svg" />
67
<title>MDMA - Interactive Document Demo</title>
78
</head>
89
<body>

demo/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
"@mobile-reality/mdma-runtime": "workspace:*",
1616
"@mobile-reality/mdma-spec": "workspace:*",
1717
"@mobile-reality/mdma-validator": "workspace:*",
18+
"highlight.js": "^11.11.1",
1819
"react": "^19.0.0",
1920
"react-dom": "^19.0.0",
2021
"recharts": "^3.7.0",

demo/public/logo.svg

Lines changed: 28 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)