|
1 | | -# Eleventy Starter Ghost |
| 1 | +# blog.libre.fm |
2 | 2 |
|
3 | | -A starter template to build completely static websites with [Ghost](https://ghost.org) & [Eleventy](https://www.11ty.io) |
4 | | - |
5 | | -**Demo:** https://eleventy.ghost.org |
6 | | - |
7 | | - |
8 | | - |
9 | | -# Installing |
10 | | - |
11 | | -```bash |
12 | | -# From Source |
13 | | -git clone https://github.com/TryGhost/eleventy-starter-ghost.git |
14 | | -cd eleventy-starter-ghost |
15 | | -``` |
16 | | - |
17 | | -Then install dependencies |
18 | | - |
19 | | -```bash |
20 | | -yarn |
21 | | -``` |
22 | | - |
23 | | -# Running |
24 | | - |
25 | | -Start the development server |
26 | | - |
27 | | -```bash |
28 | | -yarn start |
29 | | -``` |
30 | | - |
31 | | -You now have a completely static site pulling content from Ghost running as a headless CMS. |
32 | | - |
33 | | -By default, the starter will populate content from a default Ghost install located at https://eleventy.ghost.io. |
34 | | - |
35 | | -To use your own install, edit the `.env` config file with your credentials. You can find your `contentApiKey` in the "Integrations" screen in Ghost Admin. The minimum required version for Ghost is `2.10.0` in order to use this starter without issues. |
36 | | - |
37 | | -# Deploying with Netlify |
38 | | - |
39 | | -The starter contains three config files specifically for deploying with Netlify. A `netlify.toml` file for build settings, a `headers.njk` file with default security headers set for all routes (builds to `/_headers` path), and `redirects.njk` to set Netlify custom domain redirects (builds to `/_redirects` path). |
40 | | - |
41 | | -To deploy to your Netlify account, hit the button below. |
42 | | - |
43 | | -[](https://app.netlify.com/start/deploy?repository=https://github.com/TryGhost/eleventy-starter-ghost) |
44 | | - |
45 | | -Content API Keys are generally not considered to be sensitive information, they exist so that they can be changed in the event of abuse; so most people commit it directly to their `.env` config file. If you prefer to keep this information out of your repository you can remove this config and set [Netlify ENV variables](https://www.netlify.com/docs/continuous-deployment/#build-environment-variables) for production builds instead. |
46 | | - |
47 | | -Once deployed, you can set up a [Ghost + Netlify Integration](https://docs.ghost.org/integrations/netlify/) to use deploy hooks from Ghost to trigger Netlify rebuilds. That way, any time data changes in Ghost, your site will rebuild on Netlify. |
48 | | - |
49 | | -# Optimising |
50 | | - |
51 | | -You can disable the default Ghost Handlebars Theme front-end by enabling the `Make this site private` flag within your Ghost settings. This enables password protection in front of the Ghost install and sets `<meta name="robots" content="noindex" />` so your Eleventy front-end becomes the source of truth for SEO. |
52 | | - |
53 | | -# Extra options |
54 | | - |
55 | | -```bash |
56 | | -# Build the site locally |
57 | | -yarn build |
58 | | -``` |
59 | | - |
60 | | -# Copyright & License |
61 | | - |
62 | | -Copyright (c) 2013-2023 Ghost Foundation - Released under the [MIT license](LICENSE). |
| 3 | +this is the stuff i use to publish the blog. right now runs on my mac mini hence the .env but that may change. |
0 commit comments