Simiki

Variables

Site Variables

site variable is a dict, stored global site configuration and information.

In addition to the variables list below, some other variables are given in Configuration

Variable Description Other
site.time The last date time site update/generate
site.structure Store the meta data for all pages. Only exists when generating index. This variable will be moved to pages variable in the later version
site.version The version number of Simiki Generator New in version 1.5.0

Page Variables

page variable is a dict, stored the wiki page's meta data and content, etc.

In addition to the variables list below, some other variables are given in Meta Data

Variable Description
page.filename Filename of the wiki page. The last pathname component, without slash
page.content The body content of html page, without header and footer information
page.category The classification category name, relate path to content directory
page.relation The meta info of pages list, which have the same tag with current page

For example, a source file content/linux/bash.md, the page.filename is bash.md, the page.category is linux.

Index Variables

pages variable store the list of whole pages.

The sturecture looks like that:

[
  {
    "name": "linux",        # Category Name
    "pages": [
      ...
    ]
  },
  {
    "name": "tool",        # Category Name
    "pages": [             # The whole pages and collections under category
      {
        "date": "2016-01-03 00:00",
        "fname": "other1.md",        # Page without collection
        ...
      },
      {
        "name": "Version Control",        # Collection Name
        "pages": [                        # The while pages under collection
          {
            "collection": "Version Control",
            "fname": "git.md",
            "date": "2016-01-01 00:00"
            ...
          },
          {
            "collection": "Version Control",
            "fname": "svn.md",
            "date": "2016-01-02 00:00"
            ...
          }
        ]
      }
    ]
  }
]