Skip to content

Commit f45cf0c

Browse files
committed
suggestions
1 parent c83e0f5 commit f45cf0c

File tree

2 files changed

+10
-26
lines changed

2 files changed

+10
-26
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@ Documentation can be found at <https://hexdocs.pm/tableau>.
6161

6262
| Site | Template | Styling | Template | Source |
6363
|------------------------------------------------------------|-------------------------------------------------------------------------------|------------|----------|-----------------------------------------------------------------------------------|
64-
| [acrogenesis.com](https://acrogenesis.com) | [HEEx](https://hexdocs.pm/phoenix_live_view/Phoenix.Component.html#sigil_H/2) | CSS | | [acrogenesis/acrogenesis.com](https://github.com/acrogenesis/acrogenesis.com) |
6564
| [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) |
6665
| [www.mitchellhanberg.com](https://www.mitchellhanberg.com) | [Temple](https://github.com/mhanberg/temple) | Tailwind | | [mhanberg/blog](https://github.com/mhanberg/blog) |
6766
| [pdx.su](https://pdx.su) | [Temple](https://github.com/mhanberg/temple) | CSS | | [paradox460/pdx.su](https://github.com/paradox460/pdx.su) |
@@ -72,6 +71,7 @@ Documentation can be found at <https://hexdocs.pm/tableau>.
7271
| [joelkoch.dev](https://joelkoch.dev) | [HEEx](https://hexdocs.pm/phoenix_live_view/Phoenix.Component.html#sigil_H/2) | Tailwind | | [joelpaulkoch/joelkoch.dev](https://github.com/joelpaulkoch/joelkoch.dev) |
7372
| [www.ethangunderson.com](https://www.ethangunderson.com/) | [HEEx](https://hexdocs.pm/phoenix_live_view/Phoenix.Component.html#sigil_H/2) | Tailwind | | [ethangunderson/website](https://github.com/ethangunderson/website) |
7473
| [https://adrienanselme.com/](https://adrienanselme.com/) | [HEEx](https://hexdocs.pm/phoenix_live_view/Phoenix.Component.html#sigil_H/2) | Tailwind | | [adanselm/adanselm.github.io](https://github.com/adanselm/adanselm.github.io) |
74+
| [acrogenesis.com](https://acrogenesis.com) | [HEEx](https://hexdocs.pm/phoenix_live_view/Phoenix.Component.html#sigil_H/2) | CSS | | [acrogenesis/acrogenesis.com](https://github.com/acrogenesis/acrogenesis.com) |
7575

7676
## Getting Started
7777

guides/deploying-to-github-pages.md

Lines changed: 9 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,38 +2,19 @@
22

33
GitHub Pages can host the static files that Tableau produces. This guide walks through a production-ready setup that you can adopt for your own site.
44

5-
## 1. Prepare your Tableau project
5+
## Prepare your Tableau project
66

7-
1. Ensure your project exposes a `build` alias that calls `tableau.build`. The generator already includes this:
8-
9-
```elixir
10-
# mix.exs
11-
defp aliases do
12-
[
13-
build: ["tableau.build"]
14-
]
15-
end
16-
```
17-
18-
2. Make sure `_site/` is gitignored. Tableau writes the built site there and your workflow will upload it as an artifact:
19-
20-
```gitignore
21-
/_site/
22-
```
23-
24-
3. Configure your production URL in `config/prod.exs`. If you use a custom domain, set it to that value:
7+
1. Configure your production URL in `config/prod.exs`. If you use a custom domain, set it to that value:
258

269
```elixir
2710
# config/prod.exs
2811
config :tableau, :config,
2912
url: "https://your-domain.tld"
3013
```
3114

32-
For GitHub Pages sites served from `<user>.github.io/<repo>`, use the full Pages URL and optionally set `base_path: "/<repo>"` so links render correctly locally.
15+
2. If you serve additional assets (Tailwind, esbuild, etc.), add the corresponding Mix tasks to the `build` alias so they also run in CI.
3316

34-
4. If you serve additional assets (Tailwind, esbuild, etc.), add the corresponding Mix tasks to the `build` alias so they also run in CI.
35-
36-
## 2. Add the GitHub Pages workflow
17+
## Add the GitHub Pages workflow
3718

3819
Create `.github/workflows/deploy.yml` with the following workflow. It installs Erlang/OTP + Elixir, builds the site in production mode, and publishes the `_site` directory to GitHub Pages:
3920

@@ -105,20 +86,23 @@ jobs:
10586
- If `mix build` already chains your asset pipelines, no other changes are needed. Otherwise, insert additional steps before "Upload artifact".
10687
- The cache step speeds up successive runs but can be removed if you prefer.
10788

108-
## 3. Enable GitHub Pages
89+
## Enable GitHub Pages
10990

11091
1. Push the workflow to your default branch (the example uses `main`).
11192
2. In your repository, open **Settings → Pages**.
11293
3. Under **Build and deployment**, choose **GitHub Actions**.
11394
4. After the first successful run, the deployment will appear under the **Deployments** tab and the workflow output prints the public URL.
11495

115-
## 4. Using a custom domain
96+
## Custom domains & pages.io URLs
11697

11798
If you have a custom domain:
11899

119100
- Add a `CNAME` file at the repo root containing the domain, e.g. `example.com`.
120101
- Configure your DNS to point at GitHub Pages.
121102
- Keep `config :tableau, :config, url: "https://your-domain"` in sync so absolute links are generated correctly.
103+
- GitHub’s docs cover the DNS details in depth: <https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages>.
104+
105+
If you deploy to `<user>.github.io/<repo>`, use the full Pages URL (e.g. `https://username.github.io/my-site`) and optionally set `base_path: "/my-site"` in `config/prod.exs` so local links match production.
122106

123107
## Troubleshooting
124108

0 commit comments

Comments
 (0)