Ignite

<p align="center">
    <img src="images/logo.png" alt="Ignite logo" width="256" height="234" />
</p>

<p align="center">
    <img src="https://img.shields.io/badge/macOS-14.0+-2980b9.svg" />
    <img src="https://img.shields.io/badge/swift-6.0+-8e44ad.svg" />
    <a href="https://twitter.com/twostraws">
        <img src="https://img.shields.io/badge/Contact-@twostraws-95a5a6.svg?style=flat" alt="Twitter: @twostraws" />
    </a>
</p>

Ignite is a static site builder for Swift developers, offering an expressive, powerful API to build beautiful websites that work great on all devices.

Ignite doesn't try to convert SwiftUI code to HTML, or simply map HTML tags to Swift code. Instead, it aims to use SwiftUI-like syntax to help you build great websites even if you have no knowledge of HTML or CSS.


## Getting started

The easiest way to get started is to use the Ignite command-line tool included with this package.

If you use [Homebrew](https://brew.sh), you can install it like this:

```shell
brew install ignite-swift/ignite/ignite-swift
```

Alternatively, you can build and install it from source:

1. Run `git clone https://github.com/ignite-swift/Ignite` to clone this repository to your computer.
2. Change into the new directory, e.g. `cd Ignite`.
3. Now run `make` to build the Ignite command-line tool.
4. Then run `make install` to install the Ignite command-line tool to `/usr/local/bin`.
5. If that command fails because of permissions issues, you should run `sudo make install` instead.

> [!Note]
> To change install directory: `make install PREFIX_DIR=/my/install/dir`

Once that command-line tool is installed, you can run the following command to create a new site called ExampleSite:

```shell
ignite new ExampleSite
```

Once installed, the command-line tool is helpful for running a local web server for testing and for building your project.

To build your example site, run these commands:
```shell
cd ExampleSite
ignite build
```

That creates a new folder called Build with the site files. Now you can preview it. (For more details on how to build, see "Using the command-line tool" below.)

## Important: Previewing your site

> [!Tip]
> Using the Ignite tool to run a local web server is the best way to preview your site.

Once you've built your site and are ready to see how it looks, do *not* just double-click one of the files in Finder. This will open the file directly in your browser, which means it won't know how to locate the rest of your site – the stylesheets, JavaScript code, etc – so it will not display correctly.

Instead, the best way to preview your site is using the Ignite CLI tool, which you installed in Getting Started above:

- Run `ignite run --preview` to preview your site and open it in your web browser.

That will open your web browser straight to your site. You can then return to Xcode and make changes to your site freely – every time you press Cmd+R to build your site, you can refresh your browser to see the changes.


## See