Zaduma

Overview:

The Zadumaan Astro starter template is a SolidJSMDX-based theme designed for understated personal websites. It is built with various technologies including SolidJSMDX, Remark, Unified, Shiki Twoslash, Tailwind CSS, Vercel, Vercel OG, and GitHub Actions. The template provides a simple and clean structure for creating personal websites and offers a range of features and installation instructions.

Features:

• SolidJSMDX: Utilizes the SolidJSMDX framework for building the website.
• Remark and Unified: Includes Remark and Unified for Markdown parsing and manipulation.
• Shiki Twoslash: Uses Shiki Twoslash for code syntax highlighting.
• Tailwind CSS: Integrated with Tailwind CSS for easy styling and customization.
• Vercel and Vercel OG: Compatible with Vercel and Vercel OG for easy deployment and generation of Open Graph images.
• GitHub Actions: Provides support for GitHub Actions for seamless integration and deployment.

Installation:

To install the Zadumaan Astro starter template, follow these steps:

1. Click on “Use this template” to create a new repository based on the template.
2. Set the VERCEL_TOKEN, VERCEL_PROJECT_ID, and VERCEL_ORG_ID secrets to enable deployment to Vercel from GitHub Actions.
3. Add OG_IMAGE_SECRET to secure the OG image endpoint.
4. See the full usage instructions for more detailed guidance.

To run commands for the Astro project, use the following commands from the root of the project in a terminal:

• pnpm install: Installs the project dependencies.
• pnpm run dev: Starts the local development server at localhost:3000.
• pnpm run build: Builds the production site to the ./dist/ directory.
• pnpm run preview: Previews the build locally before deploying.
• pnpm run astro ...: Runs CLI commands like astro add and astro check.
• pnpm run astro --help: Provides help for using the Astro CLI.

Summary:

The Zadumaan Astro starter template is a SolidJSMDX-based theme designed for personal websites. It offers a range of features such as integration with Remark and Unified, Shiki Twoslash for code syntax highlighting, integration with Tailwind CSS for easy styling, and compatibility with Vercel and Vercel OG for seamless deployment. The template can be easily installed by cloning the repository, installing dependencies, and customizing the website according to personal preferences. With the support of GitHub Actions, deployment and integration with other services become straightforward.