tableau

# Tableau

[![Discord](https://img.shields.io/badge/Discord-5865F3?style=flat&logo=discord&logoColor=white&link=https://discord.gg/nNDMwTJ8)](https://discord.gg/6XdGnxVA2A)
[![Hex.pm](https://img.shields.io/hexpm/v/tableau)](https://hex.pm/packages/tableau)
[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/tableau/)
[![GitHub Discussions](https://img.shields.io/github/discussions/elixir-tools/tableau)](https://github.com/elixir-tools/tableau/discussions)

Static Site Generator for Elixir.

## Goals

- [x] Good code and browser reloading on file change
- [x] Easy to use the current Node.js JS/CSS tooling
- [x] Extensions
- [x] Ability to work with "data" (either dynamic data or static files)
    - [x] YAML Files
    - [x] Elixir scripts (.exs files)
- [ ] Handles stuff like Posts, RSS, sitemap, SEO.
    - [x] Posts
    - [x] RSS
    - [x] Sitemap
    - [x] Tags
    - [ ] SEO
- [x] Project generator

## Installation

The easiest way to get started is to generate a new project using the `tableau.new` mix task.

Currently the generator can create a website using several different template syntaxes and assets frameworks.

- Templates
  - [HEEx](https://github.com/phoenixframework/phoenix)
  - [Temple](https://github.com/mhanberg/temple)
  - EEx
- Assets
  - [TailwindCSS](https://tailwindcss.com)
  - Vanilla (Just a regular CSS file)

Please run `mix help tableau.new` or `mix tableau.new --help` to see all of the possible flags.

```
mix archive.install hex tableau_new

mix tableau.new my_awesome_site
```

Otherwise, you can just install Tableau into a new mix project.

```elixir
def deps do
  [
    {:tableau, "~> 0.26"}
  ]
end
```

Documentation can be found at <https://hexdocs.pm/tableau>.

## Built with Tableau

| Site                                                       | Template                                                                      | Styling    | Template | Source                                                                            |
|------------------------------------------------------------|-------------------------------------------------------------------------------|------------|----------|-----------------------------------------------------------------------------------|
| [www.elixir-tools.dev](https://www.elixir-tools.dev)       | [Temple](https://github.com/mhanberg/temple)                                  | Tailwind   |          | [elixir-tools/elixir-tools.dev](https://github.com/elixir-tools/elixir-tools.dev) |
| [www.mitchellhanberg.com](https://www.mitchellhanberg.com) |  [Temple](https://github.com/mhanberg/temple)                                 | Tailwind   |          | [mhanberg/blog](https://github.com/mhanberg/blog)                                 |
| [pdx.su](https://pdx.su)                                   | [Temple](https://github.com/mhanberg/temple)                                  | CSS        |          | [paradox460/pdx.su](https://github.com/paradox460/pd