Skip to content

Commit 202dfaa

Browse files
committed
Merge branch 'astro-v2'
2 parents f7f10f2 + f30953b commit 202dfaa

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+1772
-3193
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,6 @@ pnpm-debug.log*
1818

1919
# macOS-specific files
2020
.DS_Store
21+
22+
# ignore .astro directory
23+
.astro

.prettierignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,5 @@
99
!astro.config.mjs
1010
!package.json
1111
!.prettierrc
12-
!.eslintrc.json
12+
!.eslintrc.json
13+
!README.md

README.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ This theme is self-documented \_ which means articles/posts in this theme can al
1414

1515
## 🔥 Features
1616

17+
- [x] type-safe markdown
1718
- [x] super fast performance
1819
- [x] accessible (Keyboard/VoiceOver)
1920
- [x] responsive (mobile ~ desktops)
@@ -54,8 +55,11 @@ Inside of AstroPaper, you'll see the following folders and files:
5455
│ ├── assets/
5556
│ │ └── socialIcons.ts
5657
│ ├── components/
57-
│ ├── contents/
58-
│ │ └── some-blog-posts.md
58+
│ ├── content/
59+
│ │ | blog/
60+
│ │ | └── some-blog-posts.md
61+
│ │ └── _schemas.ts
62+
│ │ └── config.ts
5963
│ ├── layouts/
6064
│ └── pages/
6165
│ └── styles/
@@ -69,16 +73,18 @@ Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page
6973

7074
Any static assets, like images, can be placed in the `public/` directory.
7175

72-
All blog posts are stored in `src/contents/` directory.
76+
All blog posts are stored in `src/content/blog` directory.
7377

7478
## 📖 Documentation
7579

7680
Documentation can be read in two formats\_ _markdown_ & _blog post_.
7781

78-
- Configuration - [markdown](src/contents/how-to-configure-astropaper-theme.md) | [blog post](https://astro-paper.pages.dev/posts/how-to-configure-astropaper-theme/)
79-
- Add Posts - [markdown](src/contents/adding-new-post.md) | [blog post](https://astro-paper.pages.dev/posts/adding-new-posts-in-astropaper-theme/)
80-
- Customize Color Schemes - [markdown](src/contents/customizing-astropaper-theme-color-schemes.md) | [blog post](https://astro-paper.pages.dev/posts/customizing-astropaper-theme-color-schemes/)
81-
- Predefined Color Schemes - [markdown](src/contents/predefined-color-schemes.md) | [blog post](https://astro-paper.pages.dev/posts/predefined-color-schemes/)
82+
- Configuration - [markdown](src/content/blog/how-to-configure-astropaper-theme.md) | [blog post](https://astro-paper.pages.dev/posts/how-to-configure-astropaper-theme/)
83+
- Add Posts - [markdown](src/content/blog/adding-new-post.md) | [blog post](https://astro-paper.pages.dev/posts/adding-new-posts-in-astropaper-theme/)
84+
- Customize Color Schemes - [markdown](src/content/blog/customizing-astropaper-theme-color-schemes.md) | [blog post](https://astro-paper.pages.dev/posts/customizing-astropaper-theme-color-schemes/)
85+
- Predefined Color Schemes - [markdown](src/content/blog/predefined-color-schemes.md) | [blog post](https://astro-paper.pages.dev/posts/predefined-color-schemes/)
86+
87+
> For AstroPaper v1, check out [this branch](https://github.com/satnaing/astro-paper/tree/astro-paper-v1) and this [live URL](https://astro-paper-v1.astro-paper.pages.dev/)
8288
8389
## 💻 Tech Stack
8490

@@ -121,17 +127,16 @@ PUBLIC_GOOGLE_SITE_VERIFICATION=your-google-site-verification-value
121127

122128
All commands are run from the root of the project, from a terminal:
123129

124-
| Command | Action |
125-
| :--------------------- | :------------------------------------------------- |
126-
| `npm install` | Installs dependencies |
127-
| `npm run dev` | Starts local dev server at `localhost:3000` |
128-
| `npm run build` | Build your production site to `./dist/` |
129-
| `npm run preview` | Preview your build locally, before deploying |
130-
| `npm run format:check` | Check code format with Prettier |
131-
| `npm run format` | Format codes with Prettier |
132-
| `npm run cz` | Commit code changes with commitizen |
133-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro preview` |
134-
| `npm run astro --help` | Get help using the Astro CLI |
130+
| Command | Action |
131+
| :--------------------- | :------------------------------------------------------------------------------------------------------------------------------- |
132+
| `npm install` | Installs dependencies |
133+
| `npm run dev` | Starts local dev server at `localhost:3000` |
134+
| `npm run build` | Build your production site to `./dist/` |
135+
| `npm run preview` | Preview your build locally, before deploying |
136+
| `npm run format:check` | Check code format with Prettier |
137+
| `npm run format` | Format codes with Prettier |
138+
| `npm run sync` | Generates TypeScript types for all Astro modules. [Learn more](https://docs.astro.build/en/reference/cli-reference/#astro-sync). |
139+
| `npm run cz` | Commit code changes with commitizen |
135140

136141
## ✨ Feedback & Suggestions
137142

0 commit comments

Comments
 (0)