|
| 1 | +--- |
| 2 | +title: Amagaki |
| 3 | +repo: blinkk/amagaki |
| 4 | +homepage: https://amagaki.dev |
| 5 | +language: |
| 6 | + - TypeScript |
| 7 | +license: |
| 8 | + - MIT |
| 9 | +templates: |
| 10 | + - Nunjucks |
| 11 | + - React |
| 12 | + - Closure Templates |
| 13 | +startertemplaterepo: https://github.com/blinkk/amagaki-starter |
| 14 | +description: A TypeScript site generator for hand-coding interactive marketing sites. |
| 15 | +--- |
| 16 | + |
| 17 | +Amagaki is a TypeScript site generator specifically made for hand-coding high fidelity interactive marketing sites. It's smaller than Next.js or Gatsby, and offers more than Jekyll. It facilitates best practices for building content-heavy marketing sites, and it's fast. |
| 18 | + |
| 19 | +## Key concepts |
| 20 | + |
| 21 | +- TypeScript and Node |
| 22 | +- Minimal core dependencies |
| 23 | +- Inbuilt build metrics (memory usage, generated file size, routes, locales, translations) |
| 24 | +- A static site generator (not a frontend framework) |
| 25 | +- Renders pages at request time (unlike other static generators which watch and rebuild) |
| 26 | +- Localization is an inbuilt feature |
| 27 | +- Custom YAML types for extending the content layer |
| 28 | +- Benchmarking inbuilt |
| 29 | +- Separate your content (YAML, Markdown) from your templates with ease |
| 30 | + |
| 31 | +## Plugin system |
| 32 | + |
| 33 | +- Extensive hook system for adding steps throughout the lifecycle |
| 34 | +- Multiple template languages (Nunjucks as default, React, Closure Templates plugins available) |
| 35 | +- Supports CMS integration via dynamic routing |
| 36 | +- Google Sheets plugin for managing content within Google Sheets |
| 37 | + |
| 38 | +## Quick start |
| 39 | + |
| 40 | +Amagaki is distributed as an npm package. We recommend using our starter when building marketing websites from scratch. |
| 41 | + |
| 42 | +```shell |
| 43 | +git clone https://github.com/blinkk/amagaki-starter |
| 44 | +npm install |
| 45 | + |
| 46 | +# Start the dev server |
| 47 | +npm run dev |
| 48 | + |
| 49 | +# Build the site |
| 50 | +npm run build |
| 51 | +``` |
| 52 | + |
| 53 | +If you are integrating into an existing project, you can install Amagaki directly. |
| 54 | + |
| 55 | +```shell |
| 56 | +# Install Amagaki |
| 57 | +npm install --save @amagaki/amagaki |
| 58 | + |
| 59 | +# Start the dev server |
| 60 | +npx amagaki serve |
| 61 | + |
| 62 | +# Build the site |
| 63 | +npx amagaki build |
| 64 | +``` |
| 65 | + |
| 66 | +Check out the full documentation at [amagaki.dev](https://amagaki.dev/). |
0 commit comments