stackbit.yaml

stackbitVersion: ~0.2.0
ssgName: gatsby
ssgVersion: 0.1.12
buildCommand: ./ssg-build.sh
publishDir: public
staticDir: static
uploadDir: images
dataDir: src/data
pagesDir: src/pages
pageLayoutKey: template
metadata:
  title: Libris
  description: A documentation theme
  author: Stackbit
  authorURL: 'https://www.stackbit.com'
  palettes:
    blue:
      images:
        small: images/demo-256x192.png
        large: images/demo-1024x768.png
    green:
      images:
        small: images/demo-256x192.png
        large: images/demo-1024x768.png
    navy:
      images:
        small: images/demo-256x192.png
        large: images/demo-1024x768.png
    violet:
      images:
        small: images/demo-256x192.png
        large: images/demo-1024x768.png
pageData:
  - pagePath: /
    initialExpandedPaths:
      - '[0]'
      - '[0].fields.sections'
      - '[0].fields.sections.items[0]'
      - '[0].fields.sections.items[0].fields.title'
      - '[0].fields.sections.items[0].fields.content'
      - '[1]'
      - '[1].fields.palette'
stackbit_banner:
  show_banner: true
  name: Libris
  create_url: 'https://app.stackbit.com/create?theme=libris'
  github_url: 'https://github.com/stackbithq/stackbit-theme-libris'
models:
  config:
    type: config
    label: Site Configuration
    fields:
      - type: string
        name: title
        label: Title
        description: Site title
        required: true
      - type: string
        name: description
        label: Site Description
        description: The default site description used in meta data.
      - type: enum
        name: palette
        label: Palette
        description: The palette of the theme.
        options:
          - blue
          - green
          - navy
          - violet
        default: blue
      - type: object
        name: palettes
        label: Palettes
        hidden: true
        fields:
          - type: palette
            name: blue
            label: Blue
          - type: palette
            name: green
            label: Green
          - type: palette
            name: navy
            label: Navy
          - type: palette
            name: violet
            label: Violet
      - type: object
        name: header
        label: Header Configuration
        fields:
          - type: string
            name: title
            label: Header Title
            description: The title displayed in the header if no logo image added.
          - type: image
            name: logo_img
            label: Logo
            description: The logo image displayed in the header.
          - type: string
            name: url
            label: Header Title (Logo) URL
            description: >-
              The URL of the header title (logo). Useful if you want the header
              title (logo) link to another URL, rather than the home page.
          - type: boolean
            name: has_nav
            label: Enable Navigation Menu
            description: Display the navigation menu bar in the header.
            default: true
          - type: list
            name: nav_links
            label: Navigation Links
            description: List of navigation links.
            items:
              type: action_menu
      - type: object
        name: footer
        label: Footer Configuration
        fields:
          - type: string
            name: content
            label: Footer Content
            description: The copyright text displayed in the footer.
          - type: list
            name: links
            label: Links
            description: List of links in the footer.
            items:
              type: action
          - type: boolean
            name: has_social
            label: Enable Social Links
            description: Display social links in the footer.
            default: true
          - type: list
            name: social_links
            label: Social Links
            description: List of social links in the footer.
            items:
              type: action
  doc_sections:
    type: data
    file: doc_sections.yml
    label: Documentation Sections
    fields:
      - type: string
        name: root_folder
        label: Root Folder
        description: >-
          The path under which the documentation pages will be generated. For
          example, set to "/" to put all documentation pages at root, or set to
          "/docs/" to put all documentation pages under "/docs/".
        default: /docs/
        required: true
      - type: list
        name: sections
        label: Sections
        description: >-
          The main sections of the documentation. Every item must be the URL
          slug representing the section.
        items:
          type: string
  docs:
    type: page
    label: Documentation Pages
    layout: docs
    fields:
      - type: string
        name: title
        label: Title
        description: >-
          The title of the page, used both as a page title and as a navigation
          menu title.
        required: true
      - type: number
        name: weight
        label: Weight
        description: >-
          The navigation order of the documentation page. This value is ignored
          for parent section pages.
      - type: string
        name: excerpt
        label: Excerpt
        description: >-
          Short description of the documentation section. This value is used in
          documentation overview section and meta data.
  advanced:
    type: page
    label: Advanced Page
    layout: advanced
    hideContent: true
    fields:
      - type: string
        name: title
        label: Title
        description: The title of the page.
        required: true
      - type: string
        name: excerpt
        label: Excerpt
        description: The excerpt of the page displayed in meta data.
      - type: list
        name: sections
        label: Sections
        description: Page sections
        items:
          type: reference
          labelField: title
          models:
            - section_content
            - section_cta
            - section_docs
            - section_grid
            - section_hero
  blog:
    type: page
    label: Blog
    layout: blog
    file: blog/index.md
    hideContent: true
    singleInstance: true
    fields:
      - type: string
        name: title
        label: Title
        description: The title of the page.
        required: true
      - type: string
        name: subtitle
        label: Subtitle
        description: The text shown just below the page title.
      - type: string
        name: excerpt
        label: Excerpt
        description: The excerpt of the page displayed in meta data.
      - type: image
        name: image
        label: Image
        description: The image shown in the background of the page header.
  page:
    type: page
    label: Page
    layout: page
    exclude: posts/**
    fields:
      - type: string
        name: title
        label: Title
        description: The title of the page.
        required: true
      - type: string
        name: subtitle
        label: Subtitle
        description: The text shown just below the page title.
      - type: string
        name: excerpt
        label: Excerpt
        description: The excerpt of the page displayed in meta data.
      - type: image
        name: image
        label: Image
        description: The image shown below the page title and subtitle.
  post:
    type: page
    label: Post
    layout: post
    folder: posts
    fields:
      - type: string
        name: title
        label: Title
        description: The title of the post
        required: true
      - type: string
        name: subtitle
        label: Subtitle
        description: The text shown just below the post title.
      - type: date
        name: date
        label: Date
        required: true
      - type: image
        name: thumb_image
        label: Featured Image
        description: The image shown in the blog feed.
      - type: image
        name: image
        label: Alt Featured Image
        description: The image shown in the header background in the single post.
      - type: string
        name: excerpt
        label: Excerpt
        description: The excerpt of the post displayed in the blog feed and in meta data.
  section:
    type: object
    label: Section
    labelField: title
    fields:
      - type: string
        name: title
        label: Title
        description: The title of the section.
      - type: string
        name: section_id
        label: Element ID
        description: >-
          A unique identifier that can be used when linking to this section.
          Must not contain whitespace.
  section_content:
    type: object
    label: Content Section
    extends:
      - section
    fields:
      - type: image
        name: image
        label: Image
        description: The image of the section.
      - type: enum
        name: image_position
        label: Image Position
        description: The position of the image in the section.
        options:
          - left
          - right
        default: left
      - type: markdown
        name: content
        label: Content
        description: The text content of the section.
      - type: list
        name: actions
        label: Action Buttons
        items:
          type: action
  section_cta:
    type: object
    label: CTA Section
    extends:
      - section
    fields:
      - type: string
        name: subtitle
        label: Subtitle
        description: The subtitle of the section.
      - type: list
        name: actions
        label: Action Buttons
        items:
          type: action
  section_docs:
    type: object
    label: Documentation Overview Section
    extends:
      - section
    fields:
      - type: string
        name: subtitle
        label: Subtitle
        description: The subtitle of the section.
      - type: enum
        name: col_number
        label: Columns
        description: The number of documentation sections in a row.
        options:
          - two
          - three
        default: three
        required: true
  section_grid:
    type: object
    label: Grid Section
    extends:
      - section
    fields:
      - type: string
        name: subtitle
        label: Subtitle
        description: The subtitle of the section.
      - type: enum
        name: col_number
        label: Columns
        description: The number of grid items in a row.
        options:
          - two
          - three
        default: three
        required: true
      - type: list
        name: grid_items
        label: Grid Items
        items:
          type: grid_item
  section_hero:
    type: object
    label: Hero Section
    extends:
      - section
    fields:
      - type: image
        name: image
        label: Image
        description: The image shown in the background of the section.
      - type: markdown
        name: content
        label: Content
        description: The text content of the section.
      - type: list
        name: actions
        label: Action Buttons
        items:
          type: action
  grid_item:
    type: object
    label: Grid Item
    labelField: title
    fields:
      - type: string
        name: title
        label: Title
        description: The title of the grid item.
      - type: string
        name: title_url
        label: Title URL
        description: The URL of the item title.
      - type: image
        name: image
        label: Image
        description: The image of the grid item.
      - type: markdown
        name: content
        label: Content
        description: The text content of the grid item.
      - type: list
        name: actions
        label: Action Buttons
        items:
          type: action
  action:
    type: object
    label: Action
    labelField: label
    fields:
      - type: string
        name: label
        label: Label
        required: true
      - type: string
        name: url
        label: URL
        required: true
        widget: url
      - type: enum
        name: type
        label: Type
        options:
          - link
          - primary
          - secondary
          - icon
        default: link
        required: true
      - type: string
        name: icon_class
        label: Icon
        description: Font Awesome icon class name. Used only when type is "icon".
      - type: boolean
        name: new_window
        label: Open in new tab/window
        default: false
  action_menu:
    type: object
    label: Parent Action
    extends:
      - action
    fields:
      - type: boolean
        name: has_subnav
        label: Has Sub-Navigation
        default: false
      - type: list
        name: subnav_links
        label: Sub-Navigation Links
        items:
          type: action
  palette:
    type: object
    label: Palette
    fields:
      - type: object
        name: sass
        label: SASS
        fields:
          - type: color
            name: accent1
            label: accent 1
          - type: color
            name: accent2
            label: accent 2