Documentation
Last updated: June, 2025
To start using Blackhole Astro in your project development, there are several steps you must take to prepare.
Setup and Installation
Step 1: Prepare Your Tools
Ensure you have the following tools installed:
- Node.js: Download and install from nodejs.org.
- npm: Comes with Node.js, used for package management.
- Visual Studio Code: Recommended code editor, available at code.visualstudio.com.
Step 2: Open the Project
Extract the Blackhole template package and open the blackhole-astro folder in Visual Studio Code or your preferred editor.
Step 3: Install Dependencies and Run the Project
- Run
npm installin the terminal to install all required dependencies. - Start the development server with
npm run dev. Open your browser and navigate to http://localhost:4321 to preview the site. - For production, run
npm run buildto generate optimized files.
Customization
- Custom Tailwind Classes: Add or modify Tailwind classes directly in the
.astrofiles to adjust styling. - Modify Tailwind Configuration: Customize styles, fonts, color variables, and more in
src/styles/style.css. - Custom Classes: Define plugin or custom classes in
src/styles/style.css. - Custom Script, Icons, and Google Fonts: Update Script, icons, and Google Fonts directly in the
layouts/layout.astrofiles. - Replace Images: Swap out default images by updating assets in the
public/imgfolder with your own.
Need Help?
If you encounter issues or have questions about customizing, contact our support team at Lightestcode@gmail.com.