Ghost

https://docs.ghost.org/
Admin
Ghost is an open-source publishing platform designed for building and developing independent...
Tokens:275,123
Snippets:2,825
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Initialize Ghost Setup

Source: https://docs.ghost.org/install/source

Configures the package manager and runs the setup task to install dependencies and initialize the database.

```bash
corepack enable pnpm
pnpm run setup
```

--------------------------------

### Setup without starting Ghost

Source: https://docs.ghost.org/ghost-cli

Configure Ghost using `ghost setup` without automatically starting the instance afterward by using the `--no-start` flag.

```bash
ghost setup --no-start
```

--------------------------------

### Start the Eleventy development server

Source: https://docs.ghost.org/jamstack/eleventy

Run this command after installing dependencies to launch the local development server.

```bash
yarn start
```

--------------------------------

### Ghost Setup Options

Source: https://docs.ghost.org/llms-full.txt

Skip setup stages using `--no-setup-<stage-name>` flags. Configure a custom process name with `--pname`, disable stack checks with `--no-stack`, set up without starting Ghost using `--no-start`, prevent restarts on reboot with `--no-enable`, or install without prompts using `--no-prompt`.

```bash
ghost setup --no-setup-mysql
```

```bash
ghost setup --no-setup-nginx
```

```bash
ghost setup --no-setup-ssl
```

```bash
ghost setup --no-setup-systemd
```

```bash
ghost setup --no-setup-linux-user
```

```bash
ghost setup --no-setup-migrate
```

```bash
ghost setup --pname my-process
```

```bash
ghost setup --no-stack
```

```bash
ghost setup --no-start
```

```bash
ghost setup --no-enable
```

```bash
ghost setup --no-prompt
```

--------------------------------

### Install Ghost locally

Source: https://docs.ghost.org/install/local

Initializes a local Ghost installation in an empty directory.

```bash
ghost install local
```

--------------------------------

### Install Python and Setuptools on Ubuntu

Source: https://docs.ghost.org/faq/python-setuptools-required-sqlite3

On Ubuntu systems, use apt to install Python 3 and setuptools.

```bash
apt install python3-setuptools
```

--------------------------------

### Next.js Project Setup Prompts

Source: https://docs.ghost.org/llms-full.txt

Example prompts for setting up a Next.js project. This configuration uses the pages router and avoids TypeScript, ESLint, Tailwind CSS, src directory, App Router, Turbopack, and custom import aliases for simplicity.

```bash
✔ What is your project named? … my-next-app
✔ Would you like to use TypeScript? … **No** / Yes
✔ Would you like to use ESLint? … **No** / Yes
✔ Would you like to use Tailwind CSS? … **No** / Yes
✔ Would you like your code inside a src/ directory? … **No** / Yes
✔ Would you like to use App Router? … **No** / Yes
✔ Would you like to use Turbopack for next dev? … **No** / Yes
✔ Would you like to customize the import alias? … **No** / Yes
```

--------------------------------

### Install Setuptools on Windows (Pip)

Source: https://docs.ghost.org/faq/python-setuptools-required-sqlite3

After installing Python on Windows, use pip to install setuptools.

```bash
pip install setuptools
```

--------------------------------

### Execute Ghost installation

Source: https://docs.ghost.org/install/ubuntu

Run the primary installation command to trigger the configuration wizard.

```bash
ghost install
```

--------------------------------

### Install and verify the Ghost migration CLI

Source: https://docs.ghost.org/migration/beehiiv

Install the migration tool globally and verify the installation by running the command.

```sh
# Install CLI
npm install --global @tryghost/migrate

# Verify it's installed
migrate
```

--------------------------------

### Ghost Setup Stages

Source: https://docs.ghost.org/llms-full.txt

Run specific Ghost setup stages individually or skip them. Use `ghost setup mysql` to create a new MySQL user, `ghost setup nginx` to configure Nginx, `ghost setup ssl` for SSL certificates, `ghost setup linux-user` to create a Linux user, `ghost setup systemd` for systemd unit files, and `ghost setup migrate` for database migrations.

```bash
ghost setup [stages...]
```

```bash
ghost setup mysql
```

```bash
ghost setup nginx
```

```bash
ghost setup ssl
```

```bash
ghost setup nginx ssl
```

```bash
ghost setup linux-user
```

```bash
ghost setup systemd
```

```bash
ghost setup migrate
```

--------------------------------

### Navigate and Start Next.js App

Source: https://docs.ghost.org/llms-full.txt

Change directory into the newly created Next.js project and start the development server.

```bash
cd my-next-app
yarn dev
```

--------------------------------

### Install Ghost with version and environment arguments

Source: https://docs.ghost.org/ghost-cli

Use these arguments to specify the Ghost version or install locally for development purposes.

```bash
# Install a specific version (1.0.0 or higher)
ghost install [version]

# Install version 2.15.0
ghost install 2.15.0

# Install locally for development
ghost install local

# Install version 2.15.0, locally for development
ghost install 2.15.0 --local
```

--------------------------------

### Install Ghost in Development Mode

Source: https://docs.ghost.org/ghost-cli

Installs Ghost in development mode using SQLite3 and a local process manager. This is a simpler setup for local development environments.

```bash
ghost install local
```

--------------------------------

### Install and configure MySQL

Source: https://docs.ghost.org/install/ubuntu

Install MySQL and update the root user authentication method to be compatible with Ghost.

```bash
# Install MySQL
sudo apt-get install mysql-server
```

```bash
# Enter mysql
sudo mysql
# Update permissions
ALTER USER 'root'@'localhost' IDENTIFIED WITH 'mysql_native_password' BY '<your-new-root-password>';
# Reread permissions
FLUSH PRIVILEGES;
# exit mysql
exit
```

--------------------------------

### Install and configure NGINX

Source: https://docs.ghost.org/install/ubuntu

Install the NGINX web server and configure the firewall to allow traffic.

```bash
# Install NGINX
sudo apt-get install nginx
```

```bash
sudo ufw allow 'Nginx Full'
```

--------------------------------

### Install Ghost-CLI

Source: https://docs.ghost.org/install/ubuntu

Install the Ghost-CLI command-line tool globally via npm.

```bash
sudo npm install ghost-cli@latest -g
```

--------------------------------

### Install Setuptools on macOS (Local Python)

Source: https://docs.ghost.org/faq/python-setuptools-required-sqlite3

If you have Python installed locally on macOS, use this command to install setuptools.

```bash
python3 -m pip install setuptools
```

--------------------------------

### Start Ghost instance in a specific directory

Source: https://docs.ghost.org/ghost-cli

Use the `--dir` option with `ghost start` to specify the directory of the Ghost instance you want to start.

```bash
ghost start --dir /path/to/site/
```

--------------------------------

### Execute specific Ghost setup stages

Source: https://docs.ghost.org/ghost-cli

Run individual setup stages or combine them to configure specific components like MySQL, NGINX, or SSL.

```bash
# Run ghost setup with specific stages
ghost setup [stages...]

# Creates a new mysql user with minimal privileges
ghost setup mysql

# Creates an nginx config file in `./system/files/` and adds a symlink to `/etc/nginx/sites-enabled/`
ghost setup nginx

# Creates an SSL service for Ghost
ghost setup ssl

# Create an nginx and ssl setup together
ghost setup nginx ssl

# Creates a low-privileged linux user called `ghost`
ghost setup linux-user

# Creates a systemd unit file for your site
ghost setup systemd

# Runs a database migration
ghost setup migrate
```

--------------------------------

### Install Node.js

Source: https://docs.ghost.org/install/ubuntu

Install a supported version of Node.js using the Nodesource repository.

```bash
# Download and import the Nodesource GPG key
sudo apt-get update
sudo apt-get install -y ca-certificates curl gnupg
sudo mkdir -p /etc/apt/keyrings
curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg

# Create deb repository
NODE_MAJOR=22 # Use a supported version
echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_$NODE_MAJOR.x nodistro main" | sudo tee /etc/apt/sources.list.d/nodesource.list

# Run update and install
sudo apt-get update
sudo apt-get install nodejs -y
```

--------------------------------

### Skip specific setup stages

Source: https://docs.ghost.org/ghost-cli

Use these flags with `ghost setup` to skip specific configuration steps like MySQL, Nginx, SSL, systemd, Linux user setup, or data migration.

```bash
ghost setup --no-setup-mysql
```

```bash
ghost setup --no-setup-nginx
```

```bash
ghost setup --no-setup-ssl
```

```bash
ghost setup --no-setup-systemd
```

```bash
ghost setup --no-setup-linux-user
```

```bash
ghost setup --no-setup-migrate
```

--------------------------------

### Install the Content API client

Source: https://docs.ghost.org/llms-full.txt

Commands to install the package via package managers or include via CDN.

```bash
yarn add @tryghost/content-api
```

```bash
npm install @tryghost/content-api
```

```text
https://unpkg.com/@tryghost/content-api@{version}/umd/content-api.min.js
```

--------------------------------

### Install Ghost Content API

Source: https://docs.ghost.org/jamstack/next

Install the official JavaScript helper library for the Ghost Content API.

```bash
yarn add @tryghost/content-api
```

--------------------------------

### Working Example (cURL)

Source: https://docs.ghost.org/content-api

An example of how to fetch posts using cURL with the Content API.

```APIDOC
## Working Example (cURL)

### Description
This example demonstrates how to fetch posts using cURL, including the necessary headers and query parameters.

### Request Example
```bash
# cURL
# Real endpoint - copy and paste to see!
curl -H "Accept-Version: v6.0" "https://demo.ghost.io/ghost/api/content/posts/?key=22444f78447824223cefc48062"
```
```

--------------------------------

### Working Example: Fetching Posts

Source: https://docs.ghost.org/llms-full.txt

A cURL example demonstrating how to fetch posts using the Content API.

```APIDOC
## Working Example: Fetching Posts

### Description

This example shows how to use cURL to fetch a list of posts from the Ghost Content API, including specifying the API version.

### Method
GET

### Endpoint
`https://demo.ghost.io/ghost/api/content/posts/

### Parameters

#### Query Parameters
- **key** (string) - Required - Your Content API key.

#### Headers
- **Accept-Version** (string) - Required - The minimum API version (e.g., `v6.0`).

### Request Example
```bash
curl -H "Accept-Version: v6.0" "https://demo.ghost.io/ghost/api/content/posts/?key=22444f78447824223cefc48062"
```
```

--------------------------------

### Install Python and Setuptools on macOS (Brew)

Source: https://docs.ghost.org/faq/python-setuptools-required-sqlite3

Use this command on macOS with Homebrew to install both Python 3 and setuptools.

```bash
brew install python-setuptools
```

--------------------------------

### Install without prompting

Source: https://docs.ghost.org/ghost-cli

Perform a Ghost installation without interactive prompts by providing all required parameters as arguments and using the `--no-prompt` flag.

```bash
ghost setup --no-prompt
```

--------------------------------

### Example Settings Response

Source: https://docs.ghost.org/content-api/settings

This is an example of the JSON response structure for the site settings endpoint.

```json
{
    "settings": {
        "title": "Ghost",
        "description": "The professional publishing platform",
        "logo": "https://docs.ghost.io/content/images/2014/09/Ghost-Transparent-for-DARK-BG.png",
        "icon": "https://docs.ghost.io/content/images/2017/07/favicon.png",
        "accent_color": null,
        "cover_image": "https://docs.ghost.io/content/images/2019/10/publication-cover.png",
        "facebook": "ghost",
        "twitter": "@tryghost",
        "lang": "en",
        "timezone": "Etc/UTC",
        "codeinjection_head": null,
        "codeinjection_foot": "<script src=\"//rum-static.pingdom.net/pa-5d8850cd3a70310008000482.js\" async></script>",
        "navigation": [
            {
                "label": "Home",
                "url": "/"
            },
            {
                "label": "About",
                "url": "/about/"
            },
            {
                "label": "Getting Started",
                "url": "/tag/getting-started/"
            },
            {
                "label": "Try Ghost",
                "url": "https://ghost.org"
            }
        ],
        "secondary_navigation": [],
        "meta_title": null,
        "meta_description": null,
        "og_image": null,
        "og_title": null,
        "og_description": null,
        "twitter_image": null,
        "twitter_title": null,
        "twitter_description": null,
        "members_support_address": "noreply@docs.ghost.io",
        "url": "https://docs.ghost.io/"
    }
}
```

--------------------------------

### Install Ghost Content API and dependencies

Source: https://docs.ghost.org/jamstack/vuepress

Install the required packages for interacting with the Ghost API, generating YAML, and managing file system operations.

```bash
yarn add @tryghost/content-api js-yaml fs-extra
```

--------------------------------

### Create and configure installation directory

Source: https://docs.ghost.org/install/ubuntu

Prepare the server environment by creating a directory with appropriate ownership and permissions.

```bash
# Create directory: Change `sitename` to whatever you like
sudo mkdir -p /var/www/sitename

# Set directory owner: Replace <user> with the name of your user
sudo chown <user>:<user> /var/www/sitename

# Set the correct permissions
sudo chmod 775 /var/www/sitename

# Then navigate into it
cd /var/www/sitename
```

--------------------------------

### Initialize Eleventy Starter Project

Source: https://docs.ghost.org/llms-full.txt

Commands to clone the starter repository and start the development server.

```bash
git clone git@github.com:TryGhost/eleventy-starter-ghost.git
```

```bash
yarn start
```

--------------------------------

### Initialize configuration files

Source: https://docs.ghost.org/install/docker

Copies the example environment and Caddy configuration files to their active locations.

```bash
cp .env.example .env
cp caddy/Caddyfile.example caddy/Caddyfile
```

--------------------------------

### Prevent Ghost from starting on server reboot

Source: https://docs.ghost.org/ghost-cli

Use the `--no-enable` flag with `ghost setup` to prevent the process manager from automatically starting Ghost on server reboot.

```bash
ghost setup --no-enable
```

--------------------------------

### Initialize Hexo Site

Source: https://docs.ghost.org/jamstack/hexo

Create a new Hexo project directory.

```bash
hexo init my-hexo-site
```

--------------------------------

### Run Gatsby Development Server

Source: https://docs.ghost.org/jamstack/gatsby

After installing dependencies, use this command to start the local development server for your Gatsby site. Access it at http://localhost:8000/.

```bash
gatsby develop
```

--------------------------------

### Initialize Gridsome project

Source: https://docs.ghost.org/llms-full.txt

Creates a new Gridsome project using the blog starter template.

```bash
gridsome create gridsome-ghost https://github.com/gridsome/gridsome-starter-blog.git
```

--------------------------------

### Run Ghost Doctor Diagnostics

Source: https://docs.ghost.org/ghost-cli

Use `ghost doctor` to diagnose potential issues with your Ghost installation. It checks system configurations and setup processes. Run `ghost doctor --help` for more options.

```bash
ghost doctor startup
```

```bash
ghost doctor setup
```

```bash
ghost doctor --no-check-mem
```

--------------------------------

### Start Ghost Development Server

Source: https://docs.ghost.org/install/source

Launches the Ghost development environment.

```bash
pnpm dev
```

--------------------------------

### Fetch Tiers with Included Data

Source: https://docs.ghost.org/admin-api/tiers/overview

Use the `include` parameter to fetch monthly prices, yearly prices, and benefits along with tier data. This example demonstrates a GET request to retrieve all tiers with these details.

```json
// GET admin/tiers/?include=monthly_price,yearly_price,benefits
{
    "tiers": [
        {
            "id": "622727ad96a190e914ab6664",
            "name": "Free",
            "description": null,
            "slug": "free",
            "active": true,
            "type": "free",
            "welcome_page_url": null,
            "created_at": "2022-03-08T09:53:49.000Z",
            "updated_at": "2022-03-08T10:43:15.000Z",
            "stripe_prices": null,
            "monthly_price": null,
            "yearly_price": null,
            "benefits": [],
            "visibility": "public"
        },
        {
            "id": "622727ad96a190e914ab6665",
            "name": "Bronze",
            "description": "Access to basic features",
            "slug": "default-product",
            "active": true,
            "type": "paid",
            "welcome_page_url": null,
            "created_at": "2022-03-08T09:53:49.000Z",
            "updated_at": "2022-03-14T19:22:46.000Z",
            "stripe_prices": null,
            "monthly_price": 500,
            "yearly_price": 5000,
            "currency": "usd",
            "benefits": [
                "Free daily newsletter",
                "3 posts a week"
            ],
            "visibility": "public"
        }
    ],
    "meta": {
        "pagination": {
            "page": 1,
            "limit": 15,
            "pages": 1,
            "total": 2,
            "next": null,
            "prev": null
        }
    }
}

```

--------------------------------

### Paginate {{#get}} Results

Source: https://docs.ghost.org/themes/helpers/functional/get

Use the 'page' attribute to retrieve a specific page of results when the total number of posts exceeds the initial limit. For example, 'page="4"' with 'limit="5"' accesses posts 16-20.

```handlebars
{{! Get the 4th page of results.  In this case, where limit = 5, we are accessing posts 16 - 20}}
{{#get "posts" limit="5" page="4"}}{{/get}}
```

--------------------------------

### Ghost Start Options

Source: https://docs.ghost.org/llms-full.txt

Start your Ghost site using the configured process manager. Use `--dir` to specify the site directory, `-D` or `--development` for development mode, `--enable` to allow restarts on reboot, `--no-enable` to prevent restarts, and `--no-check-mem` to disable memory checks.

```bash
ghost start --dir /path/to/site/
```

```bash
ghost start -D
```

```bash
ghost start --development
```

```bash
ghost start --enable
```

```bash
ghost start --no-enable
```

```bash
ghost start --no-check-mem
```

--------------------------------

### Initialize Tinybird Setup

Source: https://docs.ghost.org/install/docker

Commands to authenticate, sync schema files, deploy configurations, and retrieve tokens for Tinybird integration.

```bash
docker compose run --rm tinybird-login
```

```bash
docker compose run --rm tinybird-sync
```

```bash
docker compose run --rm tinybird-deploy
```

```bash
docker compose run --rm tinybird-login get-tokens
```

--------------------------------

### Clone the Eleventy Starter for Ghost

Source: https://docs.ghost.org/jamstack/eleventy

Use this command to download the starter repository to your local machine.

```bash
git clone git@github.com:TryGhost/eleventy-starter-ghost.git
```

--------------------------------

### Author Response Example

Source: https://docs.ghost.org/llms-full.txt

Example JSON response structure for an author request.

```json
{
    "authors": [
        {
            "slug": "cameron",
            "id": "5ddc9b9510d8970038255d02",
            "name": "Cameron Almeida",
            "profile_image": "https://docs.ghost.io/content/images/2019/03/1c2f492a-a5d0-4d2d-b350-cdcdebc7e413.jpg",
            "cover_image": null,
            "bio": "Editor at large.",
            "website": "https://example.com",
            "location": "Cape Town",
            "facebook": "example",
            "twitter": "@example",
            "threads": null,
            "bluesky": "ghost.org",
            "mastodon": null,
            "tiktok": null,
            "youtube": null,
            "instagram": null,
            "linkedin": null,            
            "meta_title": null,
            "meta_description": null,
            "url": "https://docs.ghost.io/author/cameron/"
        }
    ]
}
```

--------------------------------

### Run Gridsome development server

Source: https://docs.ghost.org/llms-full.txt

Starts the local development server to preview the site.

```bash
gridsome develop
```

--------------------------------

### Create Gridsome Project with Blog Starter

Source: https://docs.ghost.org/jamstack/gridsome

Create a new Gridsome project using the official Blog Starter template, which is pre-configured for blog-like structures. This command fetches the starter from GitHub.

```bash
gridsome create gridsome-ghost https://github.com/gridsome/gridsome-starter-blog.git
```

--------------------------------

### Install Ghost-CLI globally

Source: https://docs.ghost.org/install/local

Installs the Ghost command-line interface globally using npm.

```bash
npm install ghost-cli@latest -g
```

--------------------------------

### Initialize Next.js Project

Source: https://docs.ghost.org/jamstack/next

Commands to scaffold a new Next.js application and start the development server.

```bash
yarn create next-app
```

```bash
✔ What is your project named? … my-next-app
✔ Would you like to use TypeScript? … **No** / Yes
✔ Would you like to use ESLint? … **No** / Yes
✔ Would you like to use Tailwind CSS? … **No** / Yes
✔ Would you like your code inside a src/ directory? … **No** / Yes
✔ Would you like to use App Router? … **No** / Yes
✔ Would you like to use Turbopack for next dev? … **No** / Yes
✔ Would you like to customize the import alias? … **No** / Yes
```

```bash
cd my-next-app
yarn dev
```

--------------------------------

### Full Async Example: Fetch and Create Ghost Posts in Hexo

Source: https://docs.ghost.org/llms-full.txt

A complete asynchronous example demonstrating fetching Ghost posts and creating them in Hexo, suitable for Hexo script plugins.

```javascript
const ghostContentAPI = require("@tryghost/content-api");

const api = new ghostContentAPI({
  url: "https://demo.ghost.io",
  key: "22444f78447824223cefc48062",
  version: "v6.0"
});

const ghostPostData = async () => {
  const data = await api.posts
    .browse({
      limit: 100
    })
    .catch(err => {
      console.error(err);
    });

  data.forEach(post => {
    const postData = {
      title: post.title,
      slug: post.slug,
      path: post.slug,
      date: post.published_at,
      content: post.html
    }

    hexo.post.create(postData, true);
  });
};

ghostPostData();
```

--------------------------------

### API Error Response Example

Source: https://docs.ghost.org/llms-full.txt

Example JSON structure for an API error response.

```json
{
    "errors": [
        {
            "message": "Unknown Content API Key",
            "errorType": "UnauthorizedError"
        }
    ]
}
```

--------------------------------

### Manage Ghost installation and maintenance

Source: https://docs.ghost.org/install/ubuntu

Commands for troubleshooting failed installations or performing routine maintenance.

```bash
ghost help
```

```bash
ghost uninstall
```

```bash
ghost setup
```

--------------------------------

### Install Hexo CLI

Source: https://docs.ghost.org/jamstack/hexo

Install the Hexo command line interface globally via npm.

```bash
npm install -g hexo-cli
```

--------------------------------

### Initialize and use the Ghost Content API client

Source: https://docs.ghost.org/llms-full.txt

Configure the client with your API URL, key, and version. Use the returned instance to browse or read resources.

```javascript
const api = new GhostContentAPI({
  url: 'https://demo.ghost.io',
  key: '22444f78447824223cefc48062',
  version: "v6.0"
});

// fetch 5 posts, including related tags and authors
api.posts
    .browse({limit: 5, include: 'tags,authors'})
    .then((posts) => {
        posts.forEach((post) => {
            console.log(post.title);
        });
    })
    .catch((err) => {
        console.error(err);
    });
```

--------------------------------

### Create New VuePress Project

Source: https://docs.ghost.org/llms-full.txt

Initializes a new VuePress project by creating a directory and navigating into it. This is the first step for setting up a custom front-end with VuePress.

```bash
# create the new project folder
mkdir vuepress-ghost

# navigate to the newly created folder
cd vuepress-ghost
```

--------------------------------

### Example recommendations.json file

Source: https://docs.ghost.org/recommendations

The JSON file located at /.well-known/recommendations.json that lists all recommended sites.

```json
[
  {
    "url": "https://shesabeast.co/",
    "updated_at": "2023-09-22T14:09:32.000Z",
    "created_at": "2023-09-22T14:09:32.000Z"
  },
  {
    "url": "https://makerstations.io/",
    "updated_at": "2023-09-22T14:12:40.000Z",
    "created_at": "2023-09-22T14:12:34.000Z"
  }
]
```

--------------------------------

### Foreach Helper @number Example

Source: https://docs.ghost.org/llms-full.txt

An example demonstrating the use of the `@number` variable for displaying 1-based numbering.

```APIDOC
## Foreach Helper @number Example

### Description
Uses the `@number` variable to display a user-friendly 1-based count for each item in a list.

### Method
Block Helper with Variable Usage

### Endpoint
N/A (Theme Helper)

### Parameters
- **@number** (number) - The 1-based index of the current iteration.

### Request Example
```handlebars theme={"dark"}
<ol>
{{#foreach posts}}
  <li>
    <a href="{{url}}">
      <span class="number" aria-hidden="true">{{@number}}</span>{{title}}
    </a>
  </li>
{{/foreach}}
</ol>
```

### Response
#### Success Response (200)
An ordered list where each item is prefixed with its 1-based number.

#### Response Example
(HTML output of an ordered list with numbered posts)
```

--------------------------------

### Tier and Subscription Pricing Examples

Source: https://docs.ghost.org/llms-full.txt

Code examples for outputting prices for all tiers and for a member's subscriptions.

```APIDOC
## Tier and Subscription Pricing Examples

### Outputting prices for all tiers:

```handlebars
{{#get "tiers" include="monthly_price,yearly_price,benefits" limit="100" as |tiers|}}
    {{#foreach tiers}}
        {{#if monthly_price}}
            <div>
                <a href="javascript:" data-portal="signup/{{id}}/monthly">Monthly – {{price monthly_price currency=currency}}</a>
            </div>
        {{/if}}
          {{#if yearly_price}}
            <div>
                <a href="javascript:" data-portal="signup/{{id}}/monthly">Monthly – {{price yearly_price currency=currency}}</a>
            </div>
        {{/if}}
    {{/foreach}}
{{/get}}
```

### Outputting prices for a member’s subscriptions:

```html
<!-- account.hbs -->

{{#foreach @member.subscriptions}}
  <div class="subscription">
    <label class="subscriber-detail-label">Your plan</label>
    <span class="subscriber-detail-content">{{price plan}}/{{plan.interval}}</span>
  </div>
{{/foreach}}
```
```

--------------------------------

### Run VuePress Development Server

Source: https://docs.ghost.org/jamstack/vuepress

Start the VuePress development server to preview your site locally. Access the site at http://localhost:8080/.

```bash
yarn dev
```

--------------------------------

### Initialize VuePress config

Source: https://docs.ghost.org/llms-full.txt

Set up the basic configuration file for the VuePress project.

```js
// .vuepress/config.js

module.exports = {
    title: 'VuePress + Ghost',
    description: 'Power your VuePress site with Ghost',
    themeConfig: {
        sidebar: []
    }
}
```

--------------------------------

### Initialize and Use Ghost Admin API Client

Source: https://docs.ghost.org/llms-full.txt

Demonstrates initializing the GhostAdminAPI client and creating a post using the server-side library.

```js
const api = new GhostAdminAPI({
  url: 'http://localhost:2368',
  key: 'YOUR_ADMIN_API_KEY',
  version: "v6.0",
});

api.posts.add({
    title: 'My first draft API post',
    lexical: '{"root":{"children":[{"children":[{"detail":0,"format":0,"mode":"normal","style":"","text":"Hello, beautiful world! 👋","type":"extended-text","version":1}],"direction":"ltr","format":"","indent":0,"type":"paragraph","version":1}],"direction":"ltr","format":"","indent":0,"type":"root","version":1}}'
});
```

--------------------------------

### Initialize and Add Post

Source: https://docs.ghost.org/admin-api/javascript

Demonstrates initializing the GhostAdminAPI client and creating a new post using Lexical content format.

```js
const api = new GhostAdminAPI({
  url: 'http://localhost:2368',
  key: 'YOUR_ADMIN_API_KEY',
  version: "v6.0",
});

api.posts.add({
    title: 'My first draft API post',
    lexical: '{"root":{"children":[{"children":[{"detail":0,"format":0,"mode":"normal","style":"","text":"Hello, beautiful world! 👋","type":"extended-text","version":1}],"direction":"ltr","format":"","indent":0,"type":"paragraph","version":1}],"direction":"ltr","format":"","indent":0,"type":"root","version":1}}'
});
```

--------------------------------

### Start Ghost services

Source: https://docs.ghost.org/install/docker

Pulls the necessary Docker images and starts the Ghost container stack in detached mode.

```bash
docker compose pull
docker compose up -d
```

--------------------------------

### Initialize Nuxt Application

Source: https://docs.ghost.org/llms-full.txt

Commands to scaffold a new Nuxt project.

```bash
yarn create nuxt-app my-nuxt-app
cd my-nuxt-app
yarn dev
```

--------------------------------

### Example Partial: Post Card

Source: https://docs.ghost.org/themes/helpers/utility/partials

This is an example of a partial file (`post-card.hbs`) that can be included in other templates to display post information.

```html
<!-- partials/post-card.hbs -->
<article class="post-card.hbs">
  <h2 class="post-card-title">
    <a href="{{url}}">{{title}}</a>
  </h2>
  <p>{{excerpt words="30"}}</p>
</article>
```
Tokens:
Raw