Skip to content

Commit d21dab2

Browse files
committed
Update README
1 parent 0f49760 commit d21dab2

1 file changed

Lines changed: 11 additions & 15 deletions

File tree

README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ Open [localhost:4321](http://localhost:4321) in your browser.
1818
## Features
1919

2020
- **Astro.js** - Fast static site generation with partial hydration
21+
- **Storybook** - Component library with nice UI to browse
2122
- **Tailwind CSS** - Utility-first styling with custom theme
2223
- **TypeScript** - Strict mode for full type safety
2324
- **Content Collections** - Type-safe blog posts with Zod validation
24-
- **Resources Library** - Optional evergreen resources collection with categories and manual ordering
2525
- **MDX Support** - Enhanced markdown with components
2626
- **RSS Feed** - Automatic feed generation (`/rss.xml`)
2727
- **Sitemap** - SEO-friendly sitemap generation (`/sitemap-index.xml`)
@@ -35,11 +35,8 @@ src/
3535
│ ├── molecules/ # Compound components
3636
│ ├── organisms/ # Section components
3737
│ └── templates/ # Page-level composition (optional)
38-
├── content/ # Blog posts and resources (MDX)
39-
├── data/ # Site-specific page copy and UI content
40-
├── data-models/ # Shared TypeScript models for data modules
4138
├── layouts/ # Page layouts
42-
├── pages/ # Routes (file-based)
39+
├── pages/ # Routes (file-based), ignores folders and files starting with underscore
4340
└── styles/ # Global styles
4441
```
4542

@@ -77,22 +74,17 @@ Story conventions (early stage):
7774

7875
## Customize Branding
7976

80-
The site branding now comes from one source of truth: `src/data/brand.ts`.
77+
The site branding now comes from one source of truth: `src/pages/_brandConfig.ts`.
8178

82-
1. Open `src/data/brand.ts`.
79+
1. Open [src/pages/_brandConfig.ts](src/pages/_brandConfig.ts).
8380
2. Update identity, organization, theme, links, SEO, and blog values.
8481
3. Keep paths aligned with your configured `base` path in `astro.config.mjs`.
8582

86-
For the complete typed example and current defaults, use `src/data/brand.ts` directly.
83+
For the complete typed example and current defaults, use `src/pages/_brandConfig.ts` directly.
8784

8885
## Site Content Pattern
8986

90-
Keep site-specific copy and content in `src/data/`, then import it into `.astro` pages.
91-
92-
- Use `src/data/home.ts`, `src/data/about.ts`, `src/data/blog.ts`, and `src/data/resources.ts` for page-level strings and labels.
93-
- Keep shared data interfaces in `src/data-models/` (including `src/data-models/brand.ts`).
94-
- Keep `.astro` pages focused on layout and rendering logic; avoid hard-coded copy in templates.
95-
- Reuse `src/data/brand.ts` for global identity, SEO defaults, and links.
87+
Except the brand config, all data is initialized in the header of the `.astro` page files.
9688

9789
## Redirects After Renaming Pages
9890

@@ -114,7 +106,7 @@ Remove the old page file, because file-based routes take precedence over configu
114106

115107
## Resources Collection
116108

117-
The template includes a `resources` collection at `src/content/resources/`.
109+
The template includes a `resources` collection at `src/pages/resources/_articles`.
118110

119111
- Use nested paths if helpful (for example `guides/interview-script-template.mdx`).
120112
- Draft entries (`draft: true`) are excluded from both resources listing and detail routes.
@@ -128,6 +120,10 @@ Supported frontmatter fields:
128120

129121
Schema source of truth: `src/content.config.ts`.
130122

123+
## Blog Articles Collection
124+
125+
Same as resources, but markdown files are located under `src/pages/blog/_articles`.
126+
131127
## Deployment
132128

133129
Configured for GitHub Pages. Update `astro.config.mjs` with your username:

0 commit comments

Comments
 (0)