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 2.7KB

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