yosql-models/yosql-models-generator/src/main/resources/frontmatterSetting.md

   1 ---
   2 title: {{setting.name}}
   3 date: {{currentDate}}
   4 menu:
   5   main:
   6     parent: {{group.name}}
   7 categories:
   8   - Configuration
   9 tags:
  10   - {{#lower}}{{group.name}}{{/lower}}
  11 {{#setting.tags}}
  12   - {{.}}
  13 {{/setting.tags}}
  14 generated: true
  15 ---
  16
  17 {{setting.description}}
  18
  19 {{#hasExplanation}}
  20 {{setting.explanation}}
  21
  22 {{/hasExplanation}}
  23 ## Configuration Options
  24
  25 {{#setting.examples}}
  26 ### Option: '{{value}}'
  27
  28 {{description}}
  29
  30 {{#result}}
  31 ```java
  32 {{{.}}}
  33 ```
  34
  35 {{/result}}
  36 {{/setting.examples}}
  37 {{#hasRelatedSettings}}
  38 ## Related Options
  39
  40 {{#relatedSettings}}
  41 - [{{name}}](../{{#lower}}{{name}}{{/lower}}/): {{description}}
  42 {{/relatedSettings}}
  43 {{/hasRelatedSettings}}
  44
  45 ## Front Matter
  46
  47 In order to configure this option, place the following code in the front matter of your SQL statement:
  48
  49 ```sql
  50 -- {{setting.name}}: {{frontMatterExampleCode}}
  51 SELECT  something
  52 FROM    your_database_schema
  53 WHERE   some_column = :some_value
  54 ```