Overview

Print Page struct to string


Table of contents


NavItem (interface)

NavItem on a Site

Signature

interface NavItem {
  /**
   *Exclude in nav
   */
  exclude?: boolean
  /**
   *this is a parent page
   */
  hasChildren?: boolean
  /**
   *Order for the NavItem
   */
  order: number
  /**
   *set parent page name
   */
  parent?: string
  /**
   *set this to the site path that contains the child pages
   */
  permaLink?: string
  /**
   *auto TABLE OF CONTENTS
   */
  toc?: boolean
}

Added in v0.2.0

Page (interface)

Page in Site

Signature

interface Page {
  /**
   *Layout for the page
   */
  layout?: string
  /**
   *Name for the page
   */
  name: string
  /**
   *nav info
   */
  nav: NavItem
  /**
   *search info
   */
  search?: SearchItem
}

Added in v0.2.0

SearchItem (interface)

Search Item in Site

Signature

interface SearchItem {
  /**
   *exclude the search
   */
  exclude?: boolean
}

Added in v0.2.0

printJekyllPage (function)

print Jekyll Page