Skip to content

Commit 3d90e74

Browse files
committed
📚 Update documentation links to point to the new hosted site
1 parent 06de3d9 commit 3d90e74

5 files changed

Lines changed: 88 additions & 88 deletions

File tree

docs/examples/index.md

Lines changed: 76 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -16,49 +16,49 @@ files:
1616
- README.md:
1717
content: |
1818
# {{@ project_name | default('My Project') @}}
19-
19+
2020
Welcome to the project!
21-
21+
2222
## Getting Started
23-
23+
2424
1. Install dependencies
2525
2. Run the application
2626
3. Enjoy!
27-
27+
2828
- .gitignore:
2929
content: |
3030
node_modules/
3131
*.log
3232
.env
3333
dist/
34-
34+
3535
- LICENSE:
3636
content: |
3737
MIT License
38-
38+
3939
Copyright (c) {{@ year | default('2024') @}} {{@ author | default('Project Author') @}}
40-
40+
4141
folders:
4242
- src/:
4343
struct:
4444
- basic/folder
4545
- docs/:
4646
struct:
4747
- basic/folder
48-
48+
4949
variables:
5050
- project_name:
51-
description: "Name of the project"
51+
description: 'Name of the project'
5252
type: string
53-
default: "My Project"
53+
default: 'My Project'
5454
- author:
55-
description: "Project author"
55+
description: 'Project author'
5656
type: string
57-
default: "Project Author"
57+
default: 'Project Author'
5858
- year:
59-
description: "Copyright year"
59+
description: 'Copyright year'
6060
type: string
61-
default: "2024"
61+
default: '2024'
6262
```
6363
6464
### Template Variables
@@ -79,44 +79,44 @@ files:
7979
"author": "{{@ author @}}",
8080
"license": "{{@ license | default('MIT') @}}"
8181
}
82-
82+
8383
- src/config.js:
8484
content: |
8585
module.exports = {
8686
appName: '{{@ app_name @}}',
8787
version: '{{@ version | default('1.0.0') @}}',
8888
environment: '{{@ environment | default('development') @}}'
8989
};
90-
90+
9191
variables:
9292
- package_name:
93-
description: "NPM package name"
93+
description: 'NPM package name'
9494
type: string
9595
required: true
9696
- app_name:
97-
description: "Application display name"
97+
description: 'Application display name'
9898
type: string
9999
required: true
100100
- description:
101-
description: "Project description"
101+
description: 'Project description'
102102
type: string
103103
required: true
104104
- author:
105-
description: "Package author"
105+
description: 'Package author'
106106
type: string
107107
required: true
108108
- version:
109-
description: "Initial version"
109+
description: 'Initial version'
110110
type: string
111-
default: "1.0.0"
111+
default: '1.0.0'
112112
- license:
113-
description: "License type"
113+
description: 'License type'
114114
type: string
115-
default: "MIT"
115+
default: 'MIT'
116116
- environment:
117-
description: "Target environment"
117+
description: 'Target environment'
118118
type: string
119-
default: "development"
119+
default: 'development'
120120
```
121121
122122
### Remote Files
@@ -129,28 +129,28 @@ Fetching content from external sources:
129129

130130
files:
131131
- .gitignore:
132-
remote: "https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore"
133-
132+
remote: 'https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore'
133+
134134
- CODE_OF_CONDUCT.md:
135-
remote: "https://raw.githubusercontent.com/contributor-covenant/contributor-covenant/main/CODE_OF_CONDUCT.md"
136-
135+
remote: 'https://raw.githubusercontent.com/contributor-covenant/contributor-covenant/main/CODE_OF_CONDUCT.md'
136+
137137
- CONTRIBUTING.md:
138138
content: |
139139
# Contributing to {{@ project_name @}}
140-
140+
141141
Thank you for your interest in contributing!
142-
142+
143143
## Development Setup
144-
144+
145145
1. Fork the repository
146146
2. Clone your fork
147147
3. Install dependencies
148148
4. Make your changes
149149
5. Submit a pull request
150-
150+
151151
variables:
152152
- project_name:
153-
description: "Project name"
153+
description: 'Project name'
154154
type: string
155155
required: true
156156
```
@@ -161,39 +161,39 @@ variables:
161161
162162
Complete Python application structure:
163163
164-
```yaml
164+
````yaml
165165
# Example: Python Project
166166
# Use case: Full Python application with proper structure
167167
168168
files:
169169
- README.md:
170170
content: |
171171
# {{@ project_name @}}
172-
172+
173173
{{@ description @}}
174-
174+
175175
## Installation
176-
176+
177177
```bash
178178
pip install -r requirements.txt
179179
```
180-
180+
181181
## Usage
182-
182+
183183
```bash
184184
python -m {{@ package_name @}}
185185
```
186-
186+
187187
- requirements.txt:
188188
content: |
189189
click>=8.0.0
190190
requests>=2.25.0
191191
pytest>=6.0.0
192-
192+
193193
- setup.py:
194194
content: |
195195
from setuptools import setup, find_packages
196-
196+
197197
setup(
198198
name="{{@ package_name @}}",
199199
version="{{@ version | default('0.1.0') @}}",
@@ -210,56 +210,56 @@ files:
210210
],
211211
},
212212
)
213-
214-
- "{{@ package_name @}}/__init__.py":
213+
214+
- '{{@ package_name @}}/__init__.py':
215215
content: |
216216
"""{{@ description @}}"""
217217
__version__ = "{{@ version | default('0.1.0') @}}"
218-
219-
- "{{@ package_name @}}/main.py":
218+
219+
- '{{@ package_name @}}/main.py':
220220
content: |
221221
"""Main application module."""
222-
222+
223223
def main():
224224
"""Main entry point."""
225225
print("Hello from {{@ project_name @}}!")
226-
226+
227227
if __name__ == "__main__":
228228
main()
229-
229+
230230
- tests/test_main.py:
231231
content: |
232232
"""Tests for main module."""
233233
import pytest
234234
from {{@ package_name @}} import main
235-
235+
236236
def test_main():
237237
"""Test main function."""
238238
# Add your tests here
239239
assert True
240-
240+
241241
variables:
242242
- project_name:
243-
description: "Project name"
243+
description: 'Project name'
244244
type: string
245245
required: true
246246
- package_name:
247-
description: "Python package name"
247+
description: 'Python package name'
248248
type: string
249249
required: true
250250
- description:
251-
description: "Project description"
251+
description: 'Project description'
252252
type: string
253253
required: true
254254
- author:
255-
description: "Project author"
255+
description: 'Project author'
256256
type: string
257257
required: true
258258
- version:
259-
description: "Initial version"
259+
description: 'Initial version'
260260
type: string
261-
default: "0.1.0"
262-
```
261+
default: '0.1.0'
262+
````
263263

264264
### Node.js API
265265

@@ -294,59 +294,59 @@ files:
294294
"supertest": "^6.3.0"
295295
}
296296
}
297-
297+
298298
- src/app.js:
299299
content: |
300300
const express = require('express');
301301
const cors = require('cors');
302302
const helmet = require('helmet');
303303
require('dotenv').config();
304-
304+
305305
const app = express();
306306
const PORT = process.env.PORT || 3000;
307-
307+
308308
// Middleware
309309
app.use(helmet());
310310
app.use(cors());
311311
app.use(express.json());
312-
312+
313313
// Routes
314314
app.get('/', (req, res) => {
315315
res.json({ message: 'Welcome to {{@ project_name @}} API' });
316316
});
317-
317+
318318
app.get('/api/health', (req, res) => {
319319
res.json({ status: 'OK', timestamp: new Date().toISOString() });
320320
});
321-
321+
322322
app.listen(PORT, () => {
323323
console.log(`{{@ project_name @}} API running on port ${PORT}`);
324324
});
325-
325+
326326
module.exports = app;
327-
327+
328328
- .env.example:
329329
content: |
330330
PORT=3000
331331
NODE_ENV=development
332-
332+
333333
variables:
334334
- project_name:
335-
description: "Project name"
335+
description: 'Project name'
336336
type: string
337337
required: true
338338
- package_name:
339-
description: "NPM package name"
339+
description: 'NPM package name'
340340
type: string
341341
required: true
342342
- description:
343-
description: "API description"
343+
description: 'API description'
344344
type: string
345345
required: true
346346
- version:
347-
description: "Initial version"
347+
description: 'Initial version'
348348
type: string
349-
default: "1.0.0"
349+
default: '1.0.0'
350350
```
351351
352352
## Usage
@@ -399,7 +399,7 @@ files:
399399
400400
variables:
401401
- example_var:
402-
description: "Example variable"
402+
description: 'Example variable'
403403
type: string
404-
default: "example_value"
404+
default: 'example_value'
405405
```

0 commit comments

Comments
 (0)