Documentation

To start using blackhole 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 folder in Visual Studio Code or your preferred editor.

Step 3: Install Dependencies and Run the Project

• Run npm install in the terminal to install all required dependencies.
• Start the development server with npm run dev. Open your browser and navigate to http://localhost:3000 to preview the site.
• For production, run npm run build to generate optimized files.

Customization

• Custom Tailwind Classes: Add or modify Tailwind classes directly in the .html files to adjust styling.
• Modify Tailwind Configuration: Customize styles, fonts, color variables, and more in src/tailwind/tailwindcss.css.
• Custom Classes: Define plugin or custom classes in src/tailwind/vendors/theme.css.
• Custom JavaScript, Icons, and Google Fonts: Update JavaScript, icons, and Google Fonts directly in the .html files.
• Replace Images: Swap out default images by updating assets in the src/img folder with your own.

Need Help?

If you encounter issues or have questions about customizing, contact our support team at Lightestcode@gmail.com.