Leverage GitHub template repositories to streamline your static site generator projects and significantly reduce setup time. While most static site generators offer easy installation, project configuration remains a recurring task. This approach is especially beneficial if you frequently create similar projects, repeatedly recreating folder structures, copying configuration files, and boilerplate code.
Unlike forking, which utilizes another developer's code, template repositories allow you to reuse your own code, ensuring each new project maintains its own independent Git history.
This guide demonstrates setting up a streamlined workflow using an Eleventy project as an example (though adaptable to Hugo, Jekyll, Nuxt, or others). A completed example repository is available for reference.
Creating Your Template
Begin by creating a project directory using the command line:
cd ~ mkdir static-site-template cd static-site-template
This navigates to your home directory, creates a new directory, and enters it.
Node Project Initialization
Eleventy requires Node.js, which allows JavaScript execution outside a web browser, and npm (Node Package Manager) for package installation. Assuming Node.js is installed, run:
npm init
This generates package.json, prompting you to provide project metadata.
Installing Eleventy
With package.json created, install Eleventy as a development dependency:
npm install -D @11ty/eleventy
This adds Eleventy to package.json and installs it to the node_modules folder. package.json ensures consistent project setup across different machines.
Eleventy Configuration
This tutorial uses a configuration that separates website source code from project files, includes an HTML document, CSS, and JavaScript. Create the necessary directory structure:
mkdir src src/css src/js touch index.html css/style.css js/main.js
To configure Eleventy to use the src directory and copy css and js files, create .eleventy.js:
module.exports = function(eleventyConfig) {
eleventyConfig.addPassthroughCopy("src/css");
eleventyConfig.addPassthroughCopy("src/js");
return {
dir: {
input: "src"
}
};
};
Test the configuration by running:
npx @11ty/eleventy
This generates the website in the _site directory.
Building a Boilerplate Website
Create basic website content: Add the following to src/index.html:
<meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Static site template</title> <meta name="description" content="A static website"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="css/style.css"> <h1>Great job making your website template!</h1> <script src="js/main.js"></script>
Add basic styling to src/css/style.css:
body {
font-family: sans-serif;
}
And a simple JavaScript function to src/js/main.js:
(function() {
console.log('Invoke the static site template JavaScript!');
})();
Run npx @11ty/eleventy --serve to view the website locally.
GitHub Repository Setup
Initialize a Git repository:
git init
Create a .gitignore file to exclude _site and node_modules:
<code>_site/ node_modules/</code>
Create a GitHub repository (e.g., static-site-template). Then, push your local repository:
git add . git commit -m "first commit" git remote add origin <your_github_repo_url> git push -u origin master</your_github_repo_url>
Enabling Template Repository
In your GitHub repository settings, enable the "Template repository" option. A "Use this template" button will appear, allowing you to create new projects based on your template.
Extending the Template
As you develop new projects using the template, add reusable components and improvements back to the template repository for future use.
Limitations
While beneficial for similar projects, template repositories may not be suitable for complex projects with external dependencies or vastly different requirements. Remember that changes to the template only affect future projects, not existing ones.
This enhanced guide provides a more comprehensive and structured approach to creating and utilizing GitHub template repositories for static site projects.
The above is the detailed content of Using GitHub Template Repos to Jump-Start Static Site Projects. For more information, please follow other related articles on the PHP Chinese website!
Hot AI Tools
Undress AI Tool
Undress images for free
Undresser.AI Undress
AI-powered app for creating realistic nude photos
AI Clothes Remover
Online AI tool for removing clothes from photos.
Clothoff.io
AI clothes remover
Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!
Hot Article
Hot Tools
Notepad++7.3.1
Easy-to-use and free code editor
SublimeText3 Chinese version
Chinese version, very easy to use
Zend Studio 13.0.1
Powerful PHP integrated development environment
Dreamweaver CS6
Visual web development tools
SublimeText3 Mac version
God-level code editing software (SublimeText3)
CSS tutorial for creating loading spinners and animations
Jul 07, 2025 am 12:07 AM
There are three ways to create a CSS loading rotator: 1. Use the basic rotator of borders to achieve simple animation through HTML and CSS; 2. Use a custom rotator of multiple points to achieve the jump effect through different delay times; 3. Add a rotator in the button and switch classes through JavaScript to display the loading status. Each approach emphasizes the importance of design details such as color, size, accessibility and performance optimization to enhance the user experience.
Addressing CSS Browser Compatibility issues and prefixes
Jul 07, 2025 am 01:44 AM
To deal with CSS browser compatibility and prefix issues, you need to understand the differences in browser support and use vendor prefixes reasonably. 1. Understand common problems such as Flexbox and Grid support, position:sticky invalid, and animation performance is different; 2. Check CanIuse confirmation feature support status; 3. Correctly use -webkit-, -moz-, -ms-, -o- and other manufacturer prefixes; 4. It is recommended to use Autoprefixer to automatically add prefixes; 5. Install PostCSS and configure browserslist to specify the target browser; 6. Automatically handle compatibility during construction; 7. Modernizr detection features can be used for old projects; 8. No need to pursue consistency of all browsers,
Creating custom shapes with css clip-path
Jul 09, 2025 am 01:29 AM
Use the clip-path attribute of CSS to crop elements into custom shapes, such as triangles, circular notches, polygons, etc., without relying on pictures or SVGs. Its advantages include: 1. Supports a variety of basic shapes such as circle, ellipse, polygon, etc.; 2. Responsive adjustment and adaptable to mobile terminals; 3. Easy to animation, and can be combined with hover or JavaScript to achieve dynamic effects; 4. It does not affect the layout flow, and only crops the display area. Common usages are such as circular clip-path:circle (50pxatcenter) and triangle clip-path:polygon (50%0%, 100 0%, 0 0%). Notice
What is the difference between display: inline, display: block, and display: inline-block?
Jul 11, 2025 am 03:25 AM
Themaindifferencesbetweendisplay:inline,block,andinline-blockinHTML/CSSarelayoutbehavior,spaceusage,andstylingcontrol.1.Inlineelementsflowwithtext,don’tstartonnewlines,ignorewidth/height,andonlyapplyhorizontalpadding/margins—idealforinlinetextstyling
Styling visited links differently with CSS
Jul 11, 2025 am 03:26 AM
Setting the style of links you have visited can improve the user experience, especially in content-intensive websites to help users navigate better. 1. Use CSS's: visited pseudo-class to define the style of the visited link, such as color changes; 2. Note that the browser only allows modification of some attributes due to privacy restrictions; 3. The color selection should be coordinated with the overall style to avoid abruptness; 4. The mobile terminal may not display this effect, and it is recommended to combine it with other visual prompts such as icon auxiliary logos.
How to create responsive images using CSS?
Jul 15, 2025 am 01:10 AM
To create responsive images using CSS, it can be mainly achieved through the following methods: 1. Use max-width:100% and height:auto to allow the image to adapt to the container width while maintaining the proportion; 2. Use HTML's srcset and sizes attributes to intelligently load the image sources adapted to different screens; 3. Use object-fit and object-position to control image cropping and focus display. Together, these methods ensure that the images are presented clearly and beautifully on different devices.
Demystifying CSS Units: px, em, rem, vw, vh comparisons
Jul 08, 2025 am 02:16 AM
The choice of CSS units depends on design requirements and responsive requirements. 1.px is used for fixed size, suitable for precise control but lack of elasticity; 2.em is a relative unit, which is easily caused by the influence of the parent element, while rem is more stable based on the root element and is suitable for global scaling; 3.vw/vh is based on the viewport size, suitable for responsive design, but attention should be paid to the performance under extreme screens; 4. When choosing, it should be determined based on whether responsive adjustments, element hierarchy relationships and viewport dependence. Reasonable use can improve layout flexibility and maintenance.
What are common CSS browser inconsistencies?
Jul 26, 2025 am 07:04 AM
Different browsers have differences in CSS parsing, resulting in inconsistent display effects, mainly including the default style difference, box model calculation method, Flexbox and Grid layout support level, and inconsistent behavior of certain CSS attributes. 1. The default style processing is inconsistent. The solution is to use CSSReset or Normalize.css to unify the initial style; 2. The box model calculation method of the old version of IE is different. It is recommended to use box-sizing:border-box in a unified manner; 3. Flexbox and Grid perform differently in edge cases or in old versions. More tests and use Autoprefixer; 4. Some CSS attribute behaviors are inconsistent. CanIuse must be consulted and downgraded.
