Skip to content

fix: render Help page Markdown content instead of plain text #947

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
hotlong merged 3 commits into from
Mar 1, 2026
Merged

fix: render Help page Markdown content instead of plain text #947

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8dcc113
Initial plan
Copilot Mar 1, 2026
8b21109
fix: use markdown component for Help page to render formatted content
Copilot Mar 1, 2026
12ae136
fix: register markdown plugin in BrowserSimulation tests
Copilot Mar 1, 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
1 change: 1 addition & 0 deletions apps/console/src/__tests__/BrowserSimulation.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { MemoryRouter } from 'react-router-dom';
import '@object-ui/fields'; // Ensure fields are registered for ObjectForm tests
import '@object-ui/plugin-dashboard'; // Ensure dashboard component is registered
import '@object-ui/plugin-report'; // Ensure report component is registered
import '@object-ui/plugin-markdown'; // Ensure markdown component is registered

// -----------------------------------------------------------------------------
// SYSTEM INTEGRATION TEST: Console Application
Expand Down
46 changes: 34 additions & 12 deletions examples/crm/src/pages/help.page.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,41 @@ export const HelpPage = {
name: 'main',
components: [
{
type: 'container',
type: 'markdown',
properties: {
className: 'prose max-w-3xl mx-auto p-8 text-foreground',
children: [
{ type: 'text', properties: { value: '# CRM Help Guide', className: 'text-3xl font-bold mb-6 block' } },
{ type: 'text', properties: { value: 'Welcome to the CRM application. This guide covers the key features available in your sales workspace.', className: 'text-muted-foreground mb-6 block' } },
{ type: 'text', properties: { value: '## Navigation', className: 'text-xl font-semibold mb-3 block' } },
{ type: 'text', properties: { value: '- **Dashboard** — KPI metrics, revenue trends, pipeline charts\n- **Contacts** — Customer and lead management with map view\n- **Accounts** — Company records with geographic map\n- **Opportunities** — Sales pipeline with Kanban board\n- **Projects** — Task tracking with Gantt and Timeline views\n- **Calendar** — Events and meetings\n- **Orders & Products** — Sales catalog and order processing', className: 'whitespace-pre-line mb-6 block' } },
{ type: 'text', properties: { value: '## View Types', className: 'text-xl font-semibold mb-3 block' } },
{ type: 'text', properties: { value: 'Each object supports multiple view types. Use the view switcher in the toolbar to change between:\n- **Grid** — Tabular data with sorting and filtering\n- **Kanban** — Drag-and-drop board (Opportunities → Pipeline)\n- **Calendar** — Date-based event view (Events → Calendar)\n- **Gantt** — Project timeline (Projects → Gantt View)\n- **Map** — Geographic visualization (Accounts → Map View)\n- **Gallery** — Visual cards (Products → Product Gallery)', className: 'whitespace-pre-line mb-6 block' } },
{ type: 'text', properties: { value: '## Keyboard Shortcuts', className: 'text-xl font-semibold mb-3 block' } },
{ type: 'text', properties: { value: '- **⌘+K** — Open Command Palette for quick navigation\n- **⌘+N** — Create new record\n- Click any record row to open the detail panel', className: 'whitespace-pre-line block' } },
]
className: 'max-w-3xl mx-auto p-8',
content: [
'# CRM Help Guide',
'',
'Welcome to the CRM application. This guide covers the key features available in your sales workspace.',
'',
'## Navigation',
'',
'- **Dashboard** — KPI metrics, revenue trends, pipeline charts',
'- **Contacts** — Customer and lead management with map view',
'- **Accounts** — Company records with geographic map',
'- **Opportunities** — Sales pipeline with Kanban board',
'- **Projects** — Task tracking with Gantt and Timeline views',
'- **Calendar** — Events and meetings',
'- **Orders & Products** — Sales catalog and order processing',
'',
'## View Types',
'',
'Each object supports multiple view types. Use the view switcher in the toolbar to change between:',
'',
'- **Grid** — Tabular data with sorting and filtering',
'- **Kanban** — Drag-and-drop board (Opportunities → Pipeline)',
'- **Calendar** — Date-based event view (Events → Calendar)',
'- **Gantt** — Project timeline (Projects → Gantt View)',
'- **Map** — Geographic visualization (Accounts → Map View)',
'- **Gallery** — Visual cards (Products → Product Gallery)',
'',
'## Keyboard Shortcuts',
'',
'- **⌘+K** — Open Command Palette for quick navigation',
'- **⌘+N** — Create new record',
'- Click any record row to open the detail panel',
].join('\n'),
}
}
]
Expand Down