Skip to content

Commit a5e1f23

Browse files
committed
change: doc formatting
1 parent f1f05ec commit a5e1f23

File tree

3 files changed

+0
-35
lines changed

3 files changed

+0
-35
lines changed

docs/COMPONENTS.md

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,6 @@ List item component with similar structure to Card.
217217

218218
```tsx
219219
import { Listing } from '@carletonuniversity/rds'
220-
221220
;<Listing>
222221
<Listing.Figure>
223222
<img src="/thumb.jpg" alt="" />
@@ -252,7 +251,6 @@ Descriptive text blocks, often used for definition lists.
252251

253252
```tsx
254253
import { Description } from '@carletonuniversity/rds'
255-
256254
;<Description title="Term" content="Definition or explanation of the term." />
257255
```
258256

@@ -264,7 +262,6 @@ Expandable/collapsible content section.
264262

265263
```tsx
266264
import { Details } from '@carletonuniversity/rds'
267-
268265
;<Details summary="Click to expand">
269266
<p>Hidden content revealed when expanded.</p>
270267
</Details>
@@ -331,7 +328,6 @@ Data table with sorting support.
331328

332329
```tsx
333330
import { Table } from '@carletonuniversity/rds'
334-
335331
;<Table>
336332
<Table.Header>
337333
<Table.Row>
@@ -358,7 +354,6 @@ Page navigation component.
358354

359355
```tsx
360356
import { Pagination } from '@carletonuniversity/rds'
361-
362357
;<Pagination currentPage={1} totalPages={10} onPageChange={(page) => setCurrentPage(page)} />
363358
```
364359

@@ -370,7 +365,6 @@ Date selection calendar.
370365

371366
```tsx
372367
import { Calendar } from '@carletonuniversity/rds'
373-
374368
;<Calendar selectedDate={selectedDate} onDateSelect={(date) => setSelectedDate(date)} />
375369
```
376370

@@ -384,7 +378,6 @@ Full-screen hero banner with video/image support.
384378

385379
```tsx
386380
import { Splash } from '@carletonuniversity/rds'
387-
388381
;<Splash>
389382
<Splash.Background>
390383
<Splash.Video src="/hero-video.mp4" />
@@ -438,7 +431,6 @@ Full-width image section.
438431

439432
```tsx
440433
import { WideImage } from '@carletonuniversity/rds'
441-
442434
;<WideImage src="/wide-image.jpg" alt="Description" caption="Image caption" />
443435
```
444436

@@ -450,7 +442,6 @@ Page header with title and metadata.
450442

451443
```tsx
452444
import { PageHeader } from '@carletonuniversity/rds'
453-
454445
;<PageHeader
455446
title="Page Title"
456447
subtitle="Page subtitle"
@@ -471,7 +462,6 @@ Minimal footer with copyright.
471462

472463
```tsx
473464
import { FooterBasic } from '@carletonuniversity/rds'
474-
475465
;<FooterBasic copyrightYear={2024} organization="Carleton University" />
476466
```
477467

@@ -481,7 +471,6 @@ Standard footer with navigation links.
481471

482472
```tsx
483473
import { FooterStandard } from '@carletonuniversity/rds'
484-
485474
;<FooterStandard links={footerLinks} socialLinks={socialLinks} />
486475
```
487476

@@ -507,7 +496,6 @@ Complex navigation component with responsive support.
507496

508497
```tsx
509498
import { Nav } from '@carletonuniversity/rds'
510-
511499
;<Nav>
512500
<Nav.Top>
513501
<Nav.Logo src="/logo.svg" alt="Logo" />
@@ -575,7 +563,6 @@ Styled blockquotes.
575563

576564
```tsx
577565
import { Quote } from '@carletonuniversity/rds'
578-
579566
;<Quote text="This is a quoted statement." author="John Doe" citation="Source Publication" />
580567
```
581568

@@ -587,7 +574,6 @@ Testimonial/review blocks.
587574

588575
```tsx
589576
import { Testimonial } from '@carletonuniversity/rds'
590-
591577
;<Testimonial quote="Great experience working with RDS!" author="Jane Smith" role="Developer" image="/jane.jpg" />
592578
```
593579

@@ -599,7 +585,6 @@ Event timeline visualization.
599585

600586
```tsx
601587
import { Timeline } from '@carletonuniversity/rds'
602-
603588
;<Timeline
604589
items={[
605590
{ date: '2024-01', title: 'Project Started', description: '...' },
@@ -617,7 +602,6 @@ Filter sidebar for search results.
617602

618603
```tsx
619604
import { FilterPanel } from '@carletonuniversity/rds'
620-
621605
;<FilterPanel
622606
filters={[
623607
{
@@ -643,7 +627,6 @@ Notification toasts.
643627

644628
```tsx
645629
import { Toast } from '@carletonuniversity/rds'
646-
647630
;<Toast
648631
type="success"
649632
message="Action completed successfully!"
@@ -660,7 +643,6 @@ Highlighted callout boxes.
660643

661644
```tsx
662645
import { CallOut } from '@carletonuniversity/rds'
663-
664646
;<CallOut type="info" title="Note">
665647
Important information for the user.
666648
</CallOut>
@@ -689,7 +671,6 @@ Images with captions.
689671

690672
```tsx
691673
import { Figure } from '@carletonuniversity/rds'
692-
693674
;<Figure src="/image.jpg" alt="Image description" caption="Figure 1: Image caption" />
694675
```
695676

@@ -721,7 +702,6 @@ Grid layout for multiple images.
721702

722703
```tsx
723704
import { ImageGrid } from '@carletonuniversity/rds'
724-
725705
;<ImageGrid
726706
images={[
727707
{ src: '/img1.jpg', alt: 'Image 1' },
@@ -740,7 +720,6 @@ Image carousel/slider.
740720

741721
```tsx
742722
import { ImageSlider } from '@carletonuniversity/rds'
743-
744723
;<ImageSlider
745724
images={[
746725
{ src: '/slide1.jpg', alt: 'Slide 1' },
@@ -792,7 +771,6 @@ import {
792771

793772
```tsx
794773
import { Forbidden403 } from '@carletonuniversity/rds'
795-
796774
;<Forbidden403 message="You don't have permission to access this page." homeLink="/" />
797775
```
798776

@@ -802,7 +780,6 @@ import { Forbidden403 } from '@carletonuniversity/rds'
802780

803781
```tsx
804782
import { NotFound404 } from '@carletonuniversity/rds'
805-
806783
;<NotFound404 message="The page you're looking for doesn't exist." homeLink="/" searchLink="/search" />
807784
```
808785

docs/FORMS.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,6 @@ Dynamic field arrays for repeatable fields.
178178

179179
```tsx
180180
import { FieldArray } from 'formik'
181-
182181
;<FieldArray name="addresses">
183182
{({ push, remove }) => (
184183
<Form.FieldArrayContainer>
@@ -246,7 +245,6 @@ Multi-line text input.
246245

247246
```tsx
248247
import { TextArea } from '@carletonuniversity/rds'
249-
250248
;<TextArea name="description" rows={5} placeholder="Enter description..." />
251249
```
252250

@@ -350,7 +348,6 @@ Radio button for single selection from options.
350348

351349
```tsx
352350
import { Radio } from '@carletonuniversity/rds'
353-
354351
;<Form.FieldSet legend="Preferred Contact Method">
355352
<Radio name="contactMethod" value="email" label="Email" />
356353
<Radio name="contactMethod" value="phone" label="Phone" />
@@ -482,7 +479,6 @@ Google Places autocomplete for address input.
482479

483480
```tsx
484481
import { PlacesAutoComplete } from '@carletonuniversity/rds'
485-
486482
;<PlacesAutoComplete
487483
name="address"
488484
placeholder="Enter address"
@@ -528,7 +524,6 @@ Helper text display for additional field information.
528524

529525
```tsx
530526
import { HelperText } from '@carletonuniversity/rds'
531-
532527
;<Form.Field name="password" label="Password">
533528
<Input name="password" type="password" />
534529
<HelperText>Must be at least 8 characters with one uppercase letter</HelperText>

docs/LAYOUTS.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ Wrapper for article content, providing proper semantic HTML and typography style
5353

5454
```tsx
5555
import { Article } from '@carletonuniversity/rds'
56-
5756
;<Article>
5857
<h1>Article Title</h1>
5958
<p>Article content with proper typography styling...</p>
@@ -81,7 +80,6 @@ Sidebar or complementary content area.
8180

8281
```tsx
8382
import { Aside } from '@carletonuniversity/rds'
84-
8583
;<div className="flex">
8684
<Main>
8785
<p>Main content</p>
@@ -123,7 +121,6 @@ Page body wrapper that provides base styling and layout constraints.
123121

124122
```tsx
125123
import { Body } from '@carletonuniversity/rds'
126-
127124
;<Body>
128125
<Nav>...</Nav>
129126
<Main>...</Main>
@@ -209,7 +206,6 @@ Floating content box that can be positioned within text content.
209206

210207
```tsx
211208
import { FloatBox } from '@carletonuniversity/rds'
212-
213209
;<Article>
214210
<p>Main article text...</p>
215211

@@ -245,7 +241,6 @@ Full-screen image background with overlay content.
245241

246242
```tsx
247243
import { ImageCover } from '@carletonuniversity/rds'
248-
249244
;<ImageCover src="/hero-image.jpg" alt="Hero background" overlay="dark">
250245
<h1>Hero Title</h1>
251246
<p>Hero description text</p>
@@ -286,7 +281,6 @@ Main content area wrapper with semantic `<main>` element.
286281

287282
```tsx
288283
import { Main } from '@carletonuniversity/rds'
289-
290284
;<Body>
291285
<Nav>...</Nav>
292286
<Main>
@@ -416,7 +410,6 @@ Wave decoration background layout for visual interest.
416410

417411
```tsx
418412
import { WideWave } from '@carletonuniversity/rds'
419-
420413
;<WideWave color="red" position="top">
421414
<Section>
422415
<h2>Featured Content</h2>

0 commit comments

Comments
 (0)