|
| 1 | +--- |
| 2 | +title: t2006 |
| 3 | +repo: cinnabar-forge/t2006 |
| 4 | +homepage: https://github.com/cinnabar-forge/t2006 |
| 5 | +language: |
| 6 | + - JavaScript |
| 7 | +license: |
| 8 | + - ISC |
| 9 | +templates: |
| 10 | + - JSON |
| 11 | +description: A small, low-opinionated static site generator with sections and items |
| 12 | +--- |
| 13 | + |
| 14 | +A small, low-opinionated static site generator with sections and items. |
| 15 | + |
| 16 | +You can change sections quantity, text, images, colors (dark-theme ready) and fonts for headers and text. |
| 17 | + |
| 18 | +Sample site: [page](https://timurrin.github.io/) and [repo](https://github.com/TimurRin/timurrin.github.io). |
| 19 | + |
| 20 | +## Configuration |
| 21 | + |
| 22 | +t2006 is driven by two main configuration files: |
| 23 | + |
| 24 | +- `data.json`: Defines the structure and content of your site. |
| 25 | +- `style.json`: Specifies the visual styling of your site. |
| 26 | + |
| 27 | +Both files examples can be found inside `sample` folder. |
| 28 | + |
| 29 | +`data.json` structure: |
| 30 | + |
| 31 | +```json |
| 32 | +{ |
| 33 | + "title": "Title text", |
| 34 | + "description": "HTML meta description text", |
| 35 | + "header": { |
| 36 | + "image": "https://dev.w3.org/SVG/tools/svgweb/samples/svg-files/why.svg", |
| 37 | + "title": "TITLE TEXT", |
| 38 | + "subtitle": "Subtitle text", |
| 39 | + "about": "About text" |
| 40 | + }, |
| 41 | + "sections": [ |
| 42 | + { |
| 43 | + "title": "SECTION TEXT", |
| 44 | + "items": [ |
| 45 | + { |
| 46 | + "name": "Line example", |
| 47 | + "image": { |
| 48 | + "path": "https://dev.w3.org/SVG/tools/svgweb/samples/svg-files/beacon.svg" |
| 49 | + }, |
| 50 | + "links": [ |
| 51 | + { "text": "link", "url": "https://example.com/" } |
| 52 | + ], |
| 53 | + "extra": "extra info" |
| 54 | + }, |
| 55 | + { |
| 56 | + "name": "Card example", |
| 57 | + "text": "If you need description", |
| 58 | + "links": [ |
| 59 | + { "text": "foo", "url": "https://example.com/" }, |
| 60 | + { "text": "bar", "url": "https://example.com/" } |
| 61 | + ] |
| 62 | + } |
| 63 | + ] |
| 64 | + } |
| 65 | + ] |
| 66 | +} |
| 67 | +``` |
| 68 | + |
| 69 | +## Usage |
| 70 | + |
| 71 | +```bash |
| 72 | +npx t2006 --input "path/to/json/data/files" --output "path/to/html/output" |
| 73 | +``` |
0 commit comments