Skip to content

Build Your Own Template

Bruce Zhang edited this page Jun 12, 2019 · 1 revision

Let's start building your own template and contribute to project now.

We are building this tool with the most popular Python template engine Jinja. If you have never use it, please read documentation here first.

Template variables used in template:

  • ig.root Current directory path
  • ig.files Files/directories listed in current directory
  • ig.files[INDEX].path Link targeting to the file/directory
  • ig.files[INDEX].name The file/directory's name
  • ig.files[INDEX].size The filesize of the file/directory - The human argument will make it human readable.
  • ig.files[INDEX].modified The modified datetime of the file/directory
  • ig.files[INDEX].mime The MIME type of the file/directory
  • ig.files[INDEX].isDir Whether this entry is a directory
  • ig.generator Basic information of this generator
  • ig.generator.name Current generator name: 'Index Generator'
  • ig.generator.version Current generator version
  • ig.generator.url Current generator's reposity link - Please add to your template if possible, thanks.

PR is always welcomed.

Clone this wiki locally