KO
|
EN
gitlite β search
Search
#typescript
#ai-agents
#ai
#dsh-plugin
#deepseek-harness
#open-source
#cli
#claude-code
#codex
#developer-tools
#react
#windows
zaduma
β 92
Open GitHub β
astro template
Download README (.md)
Explore Similar Repositories
examples
:
π Examples of use cases that utilize Decodable, as well as demos for related open-source projects such as Apache Flink, Debezium, and Postgres.
djantic2
:
Pydantic model support for Django
Parallel-Programming-and-Concurrency-with-C-sharp-10-and-.NET-6
:
Parallel Programming and Concurrency with C#10 and .NET6 published by packt
dnb-stack
:
The Remix Stack for deploying to Vercel with testing, linting, formatting, structure and mock for 3rd party API integration.
wpp-chatgpt
:
Make your whatsapp BOT talk like a human using ChatGPT!
// repository documentation
Was this content helpful?
β 0
(0 ratings)
Select Rating:
β
β
β
β
β
Submit Feedback
Recent Feedback
×
Download README
Do you want to download the
README.md
file for
zaduma
?
Download (.md)
# zaduma _an [Astro] starter template for understated personal websites_ **Built with:** - [SolidJS] - [MDX], [Remark] and [Unified] - [Shiki Twoslash][shiki-twoslash] - [Tailwind CSS][tailwind-css] - Vercel and [Vercel OG][vercel-og] - [GitHub Actions][github-actions] [astro]: https://astro.build/ [solidjs]: https://www.solidjs.com/ [mdx]: https://mdxjs.com/ [remark]: https://github.com/remarkjs/remark [unified]: https://unifiedjs.com/ [shiki-twoslash]: https://github.com/shikijs/twoslash [tailwind-css]: https://tailwindcss.com/ [vercel-og]: https://vercel.com/blog/introducing-vercel-og-image-generation-fast-dynamic-social-card-images [github-actions]: https://github.com/features/actions ## ποΈ Usage TLDR 1. Click <kbd>Use this template</kbd> to create a new repo. 2. Set [`VERCEL_TOKEN`], `VERCEL_PROJECT_ID`, and [`VERCEL_ORG_ID`] secrets to deploy to Vercel from GHA (enables access to git history). 3. Add `OG_IMAGE_SECRET` to secure your OG image endpoint. 4. Remove `e2e` directory and `playwright.config.ts` or adapt tests to your usecase. _[See full usage instructions.](#-usage)_ ## π Project Structure Inside of your Astro project, you'll see the following folders and files: <pre> <code> βββ posts/ β βββ rebuilding-a-blog.mdx β <i>posts written in <a href="https://mdxjs.com/">MDX</a></i> βββ public/ β <i>static assets apart from images</i> βββ src/ β βββ build-time/* β <i>remark plugins</i> β βββ global-styles/* β <i>fonts, body and prose styles</i> β βββ layouts/ β β βββ BaseLayout.astro β <i>UI shared between all pages</i> β β βββ PostLayout.astro β <i>layout for all posts</i> β βββ lib/* β <i>reusable utils and UI components</i> β βββ images/* β <i>pictures (need to be here to be optimized by Astro Image)</i> β βββ pages/ β β βββ [path].astro β <i>Astro dynamic route for posts, supplies MDX components</i> β β βββ index.astro β <i>index page, lists all posts</i> β βββ env.d.ts β βββ types.ts βββ astro.config.ts βββ package.json βββ postcss.config.cjs βββ tailwind.config.cjs β <i>Tailwind config, colors, fonts</i> βββ tsconfig.json </code> </pre> ## π§ Commands All commands are run from the root of the project, from a terminal: | Command | Action | | :---------------------- | :----------------------------------------------- | | `pnpm install` | Installs dependencies | | `pnpm run dev` | Starts local dev server at `localhost:3000` | | `pnpm run build` | Build your production site to `./dist/` | | `pnpm run preview` | Preview your build locally, before deploying | | `pnpm run astro ...` | Run CLI commands like `astro add`, `astro check` | | `pnpm run astro --help` | Get help using the Astro CLI | ## π Usage 1. Click <kbd>Use this template</kbd> to create a new repo. 2. Clone the repository, install with `pnpm install` and run with `pnpm dev`. 3. Style it and personalize however you like π 4. Set [`VERCEL_TOKEN`], `VERCEL_PROJECT_ID`, and [`VERCEL_ORG_ID`] secrets to deploy to Vercel from GHA (what enables access to git history). ([_SettingsβSecrets_](https://github.com/hasparus/zaduma/settings/secrets/actions)) - Alternatively β if all your blog posts have a `date` in frontmatter, you don't need to deploy through _workflows/ci.yml_. Feel free to remove the deploy steps from the YML file and connect Vercel/Netlify integration. Go to `derivedTitleAndDatePlugin` function and remove `execSync("git log")` from it. (TODO: Can we make it more convenient?) 5. Generate a passphrase for `OG_IMAGE_SECRET` to secure your OG image endpoint, and add it to [Actions Secrets](<(https://github.com/hasparus/zaduma/settings/secrets/actions)>). [`vercel_token`]: https://vercel.com/account/tokens [`vercel_org_id`]: https://vercel.com/account#your-id 6. Remove `e2e` directory and `playwright.config.ts` or adapt tests to your usecase.
