_config.yml

# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
#
# If you need help with YAML syntax, here are some quick references for you:
# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
# https://learnxinyminutes.com/docs/yaml/
#
# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.

title: HTML/CSS to Image
email: support@htmlcsstoimage.com
description: >- # this means to ignore newlines until "baseurl:"
  The API for generating high quality images from HTML/CSS. Convert HTML/CSS to an image (png, jpeg or webp).
baseurl: "" # the subpath of your site, e.g. /blog
url: "https://docs.htmlcsstoimage.com" # the base hostname & protocol for your site, e.g. http://example.com
twitter_username: htmlcsstoimage.com
github_username:  htmlcsstoimage
logo: "/assets/images/HCTI.png"

highlighter: none

# Build settings
theme: just-the-docs
color_scheme: hcti
plugins:
  - jekyll-sitemap
  - jekyll-octicons
  - jekyll-last-modified-at

defaults:
  - scope:
      path: ""
    values:
      description: "Convert HTML to an image (jpg, png, webp). Renders images exactly like Google Chrome. Works with PHP, JavaScript, Ruby, .NET and more."

last_edit_timestamp: true
last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html

cloudinary:
  cloud_name: hcti
  origin_url: https://docs.htmlcsstoimage.com
  verbose: true
  presets:
    default:
      min_width: 400
      max_width: 1200
      quality: "auto:good"
      sizes: "400px"
      fetch_format: auto
      fallback_max_width: 800
      steps: 4
      attributes:
        loading: "lazy"
        class: "cloudinary-image"

# Footer "Edit this page on GitHub" link text
gh_edit_link: true # show or hide edit this page link
gh_edit_link_text: "Edit this page on GitHub."
gh_edit_repository: "https://github.com/htmlcsstoimage/docs" # the github URL for your repo
gh_edit_branch: "main" # the branch that your docs is served from
gh_edit_view_mode: "tree"

footer_content: "Built with extensive integration tests and serious care for developer happiness. <br> &copy; 2018-2024 Code Happy, LLC."

# Back to top link
back_to_top: true
back_to_top_text: "Back to top"

# ga_tracking: UA-32961413-2
search:
  heading_level: 4

# Aux links for the upper right navigation
aux_links:
  "Get an API Key":
    - "https://htmlcsstoimage.com"
  "Demo":
    - "https://htmlcsstoimage.com/demo"

# Exclude from processing.
# The following items will not be processed, by default.
# Any item listed under the `exclude:` key here will be automatically added to
# the internal "default list".
#
# Excluded items can be processed by explicitly listing the directories or
# their entries' file path in the `include:` list.
#
exclude:
  - dist
  - searchIndex.js
  - wrangler.toml
  - workers-site/
  - archive/
  - .sass-cache/
  - .jekyll-cache/
  - gemfiles/
  - Gemfile
  - Gemfile.lock
  - node_modules/
  - vendor/bundle/
  - vendor/cache/
  - vendor/gems/
  - vendor/ruby/