You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-9Lines changed: 10 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,24 +53,24 @@ This will create a new folder `projects/myproject` with the default components a
53
53
54
54
## Step 2: Adding Components to Your Project
55
55
56
-
MiniTemplate allows you to easily add components to your project using the `add.sh` script.
56
+
MiniTemplate allows you to easily add components to your project using the `run_add.sh` script.
57
57
58
58
### List Available Components
59
59
60
-
To list all available components, run the `add.sh` script without any arguments:
60
+
To list all available components, run the `run_add.sh` script without any arguments:
61
61
62
62
```bash
63
-
./scripts/add.sh
63
+
./run_add.sh
64
64
```
65
65
66
66
You will see a list of components from `components/default`, `components/custom`, and `components/converted`.
67
67
68
68
### Add Specific Components
69
69
70
-
To add a specific component to your project, pass the component name as an argument to `add.sh`:
70
+
To add a specific component to your project, pass the component name as an argument to `run_add.sh`:
71
71
72
72
```bash
73
-
./scripts/add.sh button
73
+
./run_add.sh button
74
74
```
75
75
76
76
This will copy the `button.html` component into your project directory.
@@ -101,24 +101,25 @@ This will read all HTML files in the `source` directory and convert them into se
101
101
102
102
## Step 4: Generating the Static Site
103
103
104
-
Once you have all the necessary components in place, you can generate the final `index.html` by running the `generate_site.sh` script.
104
+
Once you have all the necessary components in place, you can generate the final `index.html` by running the `run_generate_site.sh` script.
105
105
106
106
### Generate the Static Site
107
107
108
108
```bash
109
-
./scripts/generate_site.sh
109
+
./run_generate_site.sh
110
110
```
111
111
112
-
The script reads the main template (`template_default.html`) and replaces placeholders (like`{{header_default}}`) with the corresponding component files. The generated`index.html`file will be saved in the root of your project or the `public` directory.
112
+
The script processes the main template (`template_default.html`), replacing placeholders (e.g.,`{{header_default}}`) with the appropriate component files. The resulting`index.html`can be served directly on any static web host, such as GitHub Pages.
113
113
114
114
## Step 5: Testing the Setup
115
115
116
116
You can run a suite of tests to ensure that your setup is working as expected.
117
117
118
118
### Run the Tests
119
119
120
+
navigate to the root of the project, then run:
120
121
```bash
121
-
./tests/run_tests.sh
122
+
cd./tests&& ./run_tests.sh
122
123
```
123
124
124
125
This will execute the test suite found in the `tests/` directory and validate your project’s setup, components, and templates.
0 commit comments