You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

pages-sections.md 3.2KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. +++
  2. title = "Sections and Pages"
  3. weight = 20
  4. +++
  5. Pages and sections are actually very similar.
  6. ## Page variables
  7. Gutenberg will try to load the `templates/page.html` template, the `page.html` template of the theme if one is used
  8. or will render the built-in template: a blank page.
  9. Whichever template you decide to render, you will get a `page` variable in your template
  10. with the following fields:
  11. ```ts
  12. content: String;
  13. title: String?;
  14. description: String?;
  15. date: String?;
  16. slug: String;
  17. path: String;
  18. draft: Bool;
  19. // the path, split on '/'
  20. components: Array<String>;
  21. permalink: String;
  22. summary: String?;
  23. taxonomies: HashMap<String, Array<String>>;
  24. extra: HashMap<String, Any>;
  25. // Naive word count, will not work for languages without whitespace
  26. word_count: Number;
  27. // Based on https://help.medium.com/hc/en-us/articles/214991667-Read-time
  28. reading_time: Number;
  29. // `earlier` and `later` are only populated if the section variable `sort_by` is set to `date`
  30. earlier: Page?;
  31. later: Page?;
  32. // `heavier` and `lighter` are only populated if the section variable `sort_by` is set to `weight`
  33. heavier: Page?;
  34. lighter: Page?;
  35. // See the Table of contents section below for more details
  36. toc: Array<Header>;
  37. // Year/month/day is only set if the page has a date and month/day are 1-indexed
  38. year: Number?;
  39. month: Number?;
  40. day: Number?;
  41. // Paths of colocated assets, relative to the content directory
  42. assets: Array<String>;
  43. // The relative path of the parent section if existing, for use with the `get_section` Tera function
  44. parent_section: String?;
  45. ```
  46. ## Section variables
  47. By default, Gutenberg will try to load `templates/index.html` for `content/_index.md`
  48. and `templates/section.html` for others `_index.md` files. If there isn't
  49. one, it will render the built-in template: a blank page.
  50. Whichever template you decide to render, you will get a `section` variable in your template
  51. with the following fields:
  52. ```ts
  53. content: String;
  54. title: String?;
  55. description: String?;
  56. date: String?;
  57. slug: String;
  58. path: String;
  59. // the path, split on '/'
  60. components: Array<String>;
  61. permalink: String;
  62. extra: HashMap<String, Any>;
  63. // Pages directly in this section, sorted if asked
  64. pages: Array<Pages>;
  65. // Direct subsections to this section, sorted by subsections weight
  66. // This only contains the path to use in the `get_section` Tera function to get
  67. // the actual section object if you need it
  68. subsections: Array<String>;
  69. // Unicode word count
  70. word_count: Number;
  71. // Based on https://help.medium.com/hc/en-us/articles/214991667-Read-time
  72. reading_time: Number;
  73. // See the Table of contents section below for more details
  74. toc: Array<Header>;
  75. // Paths of colocated assets, relative to the content directory
  76. assets: Array<String>;
  77. // The relative path of the parent section if existing, for use with the `get_section` Tera function
  78. parent_section: String?;
  79. ```
  80. ## Table of contents
  81. Both page and section have a `toc` field which corresponds to an array of `Header`.
  82. A `Header` has the following fields:
  83. ```ts
  84. // The hX level
  85. level: 1 | 2 | 3 | 4 | 5 | 6;
  86. // The generated slug id
  87. id: String;
  88. // The text of the header
  89. title: String;
  90. // A link pointing directly to the header, using the inserted anchor
  91. permalink: String;
  92. // All lower level headers below this header
  93. children: Array<Header>;
  94. ```