-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 315d4c0
Showing
43 changed files
with
9,746 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,187 @@ | ||
declare module 'astro:content' { | ||
interface Render { | ||
'.md': Promise<{ | ||
Content: import('astro').MarkdownInstance<{}>['Content']; | ||
headings: import('astro').MarkdownHeading[]; | ||
remarkPluginFrontmatter: Record<string, any>; | ||
}>; | ||
} | ||
} | ||
|
||
declare module 'astro:content' { | ||
export { z } from 'astro/zod'; | ||
|
||
type Flatten<T> = T extends { [K: string]: infer U } ? U : never; | ||
|
||
export type CollectionKey = keyof AnyEntryMap; | ||
export type CollectionEntry<C extends CollectionKey> = Flatten<AnyEntryMap[C]>; | ||
|
||
export type ContentCollectionKey = keyof ContentEntryMap; | ||
export type DataCollectionKey = keyof DataEntryMap; | ||
|
||
// This needs to be in sync with ImageMetadata | ||
export type ImageFunction = () => import('astro/zod').ZodObject<{ | ||
src: import('astro/zod').ZodString; | ||
width: import('astro/zod').ZodNumber; | ||
height: import('astro/zod').ZodNumber; | ||
format: import('astro/zod').ZodUnion< | ||
[ | ||
import('astro/zod').ZodLiteral<'png'>, | ||
import('astro/zod').ZodLiteral<'jpg'>, | ||
import('astro/zod').ZodLiteral<'jpeg'>, | ||
import('astro/zod').ZodLiteral<'tiff'>, | ||
import('astro/zod').ZodLiteral<'webp'>, | ||
import('astro/zod').ZodLiteral<'gif'>, | ||
import('astro/zod').ZodLiteral<'svg'>, | ||
import('astro/zod').ZodLiteral<'avif'>, | ||
] | ||
>; | ||
}>; | ||
|
||
type BaseSchemaWithoutEffects = | ||
| import('astro/zod').AnyZodObject | ||
| import('astro/zod').ZodUnion<[BaseSchemaWithoutEffects, ...BaseSchemaWithoutEffects[]]> | ||
| import('astro/zod').ZodDiscriminatedUnion<string, import('astro/zod').AnyZodObject[]> | ||
| import('astro/zod').ZodIntersection<BaseSchemaWithoutEffects, BaseSchemaWithoutEffects>; | ||
|
||
type BaseSchema = | ||
| BaseSchemaWithoutEffects | ||
| import('astro/zod').ZodEffects<BaseSchemaWithoutEffects>; | ||
|
||
export type SchemaContext = { image: ImageFunction }; | ||
|
||
type DataCollectionConfig<S extends BaseSchema> = { | ||
type: 'data'; | ||
schema?: S | ((context: SchemaContext) => S); | ||
}; | ||
|
||
type ContentCollectionConfig<S extends BaseSchema> = { | ||
type?: 'content'; | ||
schema?: S | ((context: SchemaContext) => S); | ||
}; | ||
|
||
type CollectionConfig<S> = ContentCollectionConfig<S> | DataCollectionConfig<S>; | ||
|
||
export function defineCollection<S extends BaseSchema>( | ||
input: CollectionConfig<S> | ||
): CollectionConfig<S>; | ||
|
||
type AllValuesOf<T> = T extends any ? T[keyof T] : never; | ||
type ValidContentEntrySlug<C extends keyof ContentEntryMap> = AllValuesOf< | ||
ContentEntryMap[C] | ||
>['slug']; | ||
|
||
export function getEntryBySlug< | ||
C extends keyof ContentEntryMap, | ||
E extends ValidContentEntrySlug<C> | (string & {}), | ||
>( | ||
collection: C, | ||
// Note that this has to accept a regular string too, for SSR | ||
entrySlug: E | ||
): E extends ValidContentEntrySlug<C> | ||
? Promise<CollectionEntry<C>> | ||
: Promise<CollectionEntry<C> | undefined>; | ||
|
||
export function getDataEntryById<C extends keyof DataEntryMap, E extends keyof DataEntryMap[C]>( | ||
collection: C, | ||
entryId: E | ||
): Promise<CollectionEntry<C>>; | ||
|
||
export function getCollection<C extends keyof AnyEntryMap, E extends CollectionEntry<C>>( | ||
collection: C, | ||
filter?: (entry: CollectionEntry<C>) => entry is E | ||
): Promise<E[]>; | ||
export function getCollection<C extends keyof AnyEntryMap>( | ||
collection: C, | ||
filter?: (entry: CollectionEntry<C>) => unknown | ||
): Promise<CollectionEntry<C>[]>; | ||
|
||
export function getEntry< | ||
C extends keyof ContentEntryMap, | ||
E extends ValidContentEntrySlug<C> | (string & {}), | ||
>(entry: { | ||
collection: C; | ||
slug: E; | ||
}): E extends ValidContentEntrySlug<C> | ||
? Promise<CollectionEntry<C>> | ||
: Promise<CollectionEntry<C> | undefined>; | ||
export function getEntry< | ||
C extends keyof DataEntryMap, | ||
E extends keyof DataEntryMap[C] | (string & {}), | ||
>(entry: { | ||
collection: C; | ||
id: E; | ||
}): E extends keyof DataEntryMap[C] | ||
? Promise<DataEntryMap[C][E]> | ||
: Promise<CollectionEntry<C> | undefined>; | ||
export function getEntry< | ||
C extends keyof ContentEntryMap, | ||
E extends ValidContentEntrySlug<C> | (string & {}), | ||
>( | ||
collection: C, | ||
slug: E | ||
): E extends ValidContentEntrySlug<C> | ||
? Promise<CollectionEntry<C>> | ||
: Promise<CollectionEntry<C> | undefined>; | ||
export function getEntry< | ||
C extends keyof DataEntryMap, | ||
E extends keyof DataEntryMap[C] | (string & {}), | ||
>( | ||
collection: C, | ||
id: E | ||
): E extends keyof DataEntryMap[C] | ||
? Promise<DataEntryMap[C][E]> | ||
: Promise<CollectionEntry<C> | undefined>; | ||
|
||
/** Resolve an array of entry references from the same collection */ | ||
export function getEntries<C extends keyof ContentEntryMap>( | ||
entries: { | ||
collection: C; | ||
slug: ValidContentEntrySlug<C>; | ||
}[] | ||
): Promise<CollectionEntry<C>[]>; | ||
export function getEntries<C extends keyof DataEntryMap>( | ||
entries: { | ||
collection: C; | ||
id: keyof DataEntryMap[C]; | ||
}[] | ||
): Promise<CollectionEntry<C>[]>; | ||
|
||
export function reference<C extends keyof AnyEntryMap>( | ||
collection: C | ||
): import('astro/zod').ZodEffects< | ||
import('astro/zod').ZodString, | ||
C extends keyof ContentEntryMap | ||
? { | ||
collection: C; | ||
slug: ValidContentEntrySlug<C>; | ||
} | ||
: { | ||
collection: C; | ||
id: keyof DataEntryMap[C]; | ||
} | ||
>; | ||
// Allow generic `string` to avoid excessive type errors in the config | ||
// if `dev` is not running to update as you edit. | ||
// Invalid collection names will be caught at build time. | ||
export function reference<C extends string>( | ||
collection: C | ||
): import('astro/zod').ZodEffects<import('astro/zod').ZodString, never>; | ||
|
||
type ReturnTypeOrOriginal<T> = T extends (...args: any[]) => infer R ? R : T; | ||
type InferEntrySchema<C extends keyof AnyEntryMap> = import('astro/zod').infer< | ||
ReturnTypeOrOriginal<Required<ContentConfig['collections'][C]>['schema']> | ||
>; | ||
|
||
type ContentEntryMap = { | ||
|
||
}; | ||
|
||
type DataEntryMap = { | ||
|
||
}; | ||
|
||
type AnyEntryMap = ContentEntryMap & DataEntryMap; | ||
|
||
type ContentConfig = never; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
*xsl linguist-vendored |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# build output | ||
dist/ | ||
|
||
# dependencies | ||
node_modules/ | ||
|
||
# logs | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
pnpm-debug.log* | ||
|
||
|
||
# environment variables | ||
.env | ||
.env.production | ||
|
||
# macOS-specific files | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
node_modules/** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"useTabs": true, | ||
"singleQuote": true, | ||
"trailingComma": "none", | ||
"semi": true, | ||
"printWidth": 100, | ||
"plugins": ["prettier-plugin-astro", "prettier-plugin-tailwindcss"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2024 Nicolas Dunke | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# Astro & Tailwind CSS Starter Kit | ||
|
||
## Features | ||
|
||
Explore the Astro.js Personal Blog Template – a sleek and feature-rich platform for your personal blog: | ||
|
||
- **Astro.js Powered**: Dynamic and efficient JavaScript-driven experience. | ||
- **Tailwind CSS Integration**: Ensures a stylish and responsive design. | ||
- **RSS Feed Support**: Keeps your audience updated effortlessly. | ||
- **Markdown Compatibility**: Streamlines content creation with easy formatting. | ||
- **Syntax Highlighting**: Enhances code snippet readability for tech enthusiasts. | ||
- **SEO-Optimized**: Includes a sitemap for optimal search engine visibility. | ||
- **Vercel Deployment:** preconfigured Vercel deployment & web analytics. | ||
- **Framework of your choice:** 100% Astro.js only template - choose your JS Framework (react preinstalled) | ||
|
||
Unlock a seamless blend of aesthetics and functionality to share your unique voice with the world. | ||
|
||
## Showcase | ||
|
||
![showcase](/public/showcase.png 'AstroPress - Tech Blog Template') | ||
|
||
## Template Integrations | ||
|
||
- @astrojs/tailwind - https://docs.astro.build/en/guides/integrations-guide/tailwind/ | ||
- @astrojs/react - https://docs.astro.build/en/guides/integrations-guide/react/ | ||
- @astrojs/sitemap - https://docs.astro.build/en/guides/integrations-guide/sitemap/ | ||
- @astrojs/rss - https://docs.astro.build/en/guides/rss/ | ||
- @vercel/analytics - https://vercel.com/docs/analytics/ | ||
- rehype-pretty-code - https://rehype-pretty-code.netlify.app/ | ||
|
||
## Template Structure | ||
|
||
Inside of your Astro project, you'll see the following folders and files: | ||
|
||
``` | ||
/ | ||
├── public/ | ||
├── src/ | ||
│ └── pages/ | ||
│ └── index.astro | ||
└── package.json | ||
``` | ||
|
||
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. | ||
|
||
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. | ||
|
||
Any static assets, like images, can be placed in the `public/` directory. | ||
|
||
## Commands | ||
|
||
All commands are run from the root of the project, from a terminal: | ||
|
||
| Command | Action | | ||
| :--------------------- | :----------------------------------------------- | | ||
| `npm install` | Installs dependencies | | ||
| `npm run dev` | Starts local dev server at `localhost:3000` | | ||
| `npm run build` | Build your production site to `./dist/` | | ||
| `npm run preview` | Preview your build locally, before deploying | | ||
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | | ||
| `npm run astro --help` | Get help using the Astro CLI | | ||
|
||
## Want to learn more? | ||
|
||
Feel free to check Astros [documentation](https://docs.astro.build) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
import { defineConfig } from 'astro/config'; | ||
import tailwind from '@astrojs/tailwind'; | ||
import { remarkReadingTime } from './src/utils/readingTime'; | ||
import rehypePrettyCode from 'rehype-pretty-code'; | ||
import vercelStatic from '@astrojs/vercel/static'; | ||
import react from '@astrojs/react'; | ||
import sitemap from "@astrojs/sitemap"; | ||
const options = { | ||
// Specify the theme to use or a custom theme json, in our case | ||
// it will be a moonlight-II theme from | ||
// https://github.com/atomiks/moonlight-vscode-theme/blob/master/src/moonlight-ii.json | ||
// Callbacks to customize the output of the nodes | ||
//theme: json, | ||
onVisitLine(node) { | ||
// Prevent lines from collapsing in `display: grid` mode, and | ||
// allow empty lines to be copy/pasted | ||
if (node.children.length === 0) { | ||
node.children = [{ | ||
type: 'text', | ||
value: ' ' | ||
}]; | ||
} | ||
}, | ||
onVisitHighlightedLine(node) { | ||
// Adding a class to the highlighted line | ||
node.properties.className = ['highlighted']; | ||
} | ||
}; | ||
|
||
|
||
// https://astro.build/config | ||
export default defineConfig({ | ||
site: 'https://astro-tech-blog-ten.vercel.app/', | ||
markdown: { | ||
syntaxHighlight: false, | ||
// Disable syntax built-in syntax hightlighting from astro | ||
rehypePlugins: [[rehypePrettyCode, options]], | ||
remarkPlugins: [remarkReadingTime] | ||
}, | ||
integrations: [tailwind(), react(), sitemap()], | ||
output: 'static', | ||
adapter: vercelStatic({ | ||
webAnalytics: { | ||
enabled: true | ||
} | ||
}) | ||
}); |
Oops, something went wrong.