Skip to content

Commit

Permalink
Start of docs for 11ty/eleventy#836
Browse files Browse the repository at this point in the history
  • Loading branch information
zachleat committed Sep 23, 2024
1 parent cc648a1 commit 3707a85
Show file tree
Hide file tree
Showing 19 changed files with 454 additions and 155 deletions.
32 changes: 32 additions & 0 deletions src/_includes/config/config-data.njk
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{%- set tabid = "config-data" %}
<is-land on:visible import="/js/seven-minute-tabs.js">
<seven-minute-tabs class="tabs-full tabs-flush" persist sync>
{% renderFile "./src/_includes/syntax-chooser-tablist.11ty.js", {id: tabid, only: "jsesm,jscjs"} %}
<div id="{{ tabid }}-jsesm" role="tabpanel">

```js
export const config = {
dir: {
// ⚠️ This value is relative to your input directory.
data: "lore",
}
};
```

</div>
<div id="{{ tabid }}-jscjs" role="tabpanel">

```js
module.exports.config = {
dir: {
// ⚠️ This value is relative to your input directory.
data: "lore",
}
};
```

</div>
</seven-minute-tabs>
</is-land>

There are many [different shapes of configuration file](/docs/config-shapes.md).
26 changes: 26 additions & 0 deletions src/_includes/config/config-htmlengine.njk
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{%- set tabid = "config-htmlengine" %}
<is-land on:visible import="/js/seven-minute-tabs.js">
<seven-minute-tabs class="tabs-full tabs-flush" persist sync>
{% renderFile "./src/_includes/syntax-chooser-tablist.11ty.js", {id: tabid, only: "jsesm,jscjs"} %}
<div id="{{ tabid }}-jsesm" role="tabpanel">

```js
export const config = {
htmlTemplateEngine: "njk",
};
```

</div>
<div id="{{ tabid }}-jscjs" role="tabpanel">

```js
module.exports.config = {
htmlTemplateEngine: "njk",
};
```

</div>
</seven-minute-tabs>
</is-land>

There are many [different shapes of configuration file](/docs/config-shapes.md).
32 changes: 32 additions & 0 deletions src/_includes/config/config-includes.njk
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{%- set tabid = "config-includes" %}
<is-land on:visible import="/js/seven-minute-tabs.js">
<seven-minute-tabs class="tabs-full tabs-flush" persist sync>
{% renderFile "./src/_includes/syntax-chooser-tablist.11ty.js", {id: tabid, only: "jsesm,jscjs"} %}
<div id="{{ tabid }}-jsesm" role="tabpanel">

```js
export const config = {
dir: {
// ⚠️ This value is relative to your input directory.
includes: "my_includes"
}
};
```

</div>
<div id="{{ tabid }}-jscjs" role="tabpanel">

```js
module.exports.config = {
dir: {
// ⚠️ This value is relative to your input directory.
includes: "my_includes"
}
};
```

</div>
</seven-minute-tabs>
</is-land>

There are many [different shapes of configuration file](/docs/config-shapes.md).
30 changes: 30 additions & 0 deletions src/_includes/config/config-input.njk
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{%- set tabid = "config-input" %}
<is-land on:visible import="/js/seven-minute-tabs.js">
<seven-minute-tabs class="tabs-full tabs-flush" persist sync>
{% renderFile "./src/_includes/syntax-chooser-tablist.11ty.js", {id: tabid, only: "jsesm,jscjs"} %}
<div id="{{ tabid }}-jsesm" role="tabpanel">

```js
export const config = {
dir: {
input: "views"
}
};
```

</div>
<div id="{{ tabid }}-jscjs" role="tabpanel">

```js
module.exports.config = {
dir: {
input: "views"
}
};
```

</div>
</seven-minute-tabs>
</is-land>

There are many [different shapes of configuration file](/docs/config-shapes.md).
34 changes: 34 additions & 0 deletions src/_includes/config/config-layouts.njk
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{%- set tabid = "config-layouts" %}
<is-land on:visible import="/js/seven-minute-tabs.js">
<seven-minute-tabs class="tabs-full tabs-flush" persist sync>
{% renderFile "./src/_includes/syntax-chooser-tablist.11ty.js", {id: tabid, only: "jsesm,jscjs"} %}
<div id="{{ tabid }}-jsesm" role="tabpanel">

```js
export const config = {
dir: {
// ⚠️ These values are both relative to your input directory.
includes: "_includes",
layouts: "_layouts",
}
};
```

</div>
<div id="{{ tabid }}-jscjs" role="tabpanel">

```js
module.exports.config = {
dir: {
// ⚠️ These values are both relative to your input directory.
includes: "_includes",
layouts: "_layouts",
}
};
```

</div>
</seven-minute-tabs>
</is-land>

There are many [different shapes of configuration file](/docs/config-shapes.md).
26 changes: 26 additions & 0 deletions src/_includes/config/config-mdengine.njk
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{%- set tabid = "config-mdengine" %}
<is-land on:visible import="/js/seven-minute-tabs.js">
<seven-minute-tabs class="tabs-full tabs-flush" persist sync>
{% renderFile "./src/_includes/syntax-chooser-tablist.11ty.js", {id: tabid, only: "jsesm,jscjs"} %}
<div id="{{ tabid }}-jsesm" role="tabpanel">

```js
export const config = {
markdownTemplateEngine: "njk",
};
```

</div>
<div id="{{ tabid }}-jscjs" role="tabpanel">

```js
module.exports.config = {
markdownTemplateEngine: "njk",
};
```

</div>
</seven-minute-tabs>
</is-land>

There are many [different shapes of configuration file](/docs/config-shapes.md).
30 changes: 30 additions & 0 deletions src/_includes/config/config-output.njk
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{%- set tabid = "config-output" %}
<is-land on:visible import="/js/seven-minute-tabs.js">
<seven-minute-tabs class="tabs-full tabs-flush" persist sync>
{% renderFile "./src/_includes/syntax-chooser-tablist.11ty.js", {id: tabid, only: "jsesm,jscjs"} %}
<div id="{{ tabid }}-jsesm" role="tabpanel">

```js
export const config = {
dir: {
output: "dist",
}
};
```

</div>
<div id="{{ tabid }}-jscjs" role="tabpanel">

```js
module.exports.config = {
dir: {
output: "dist",
}
};
```

</div>
</seven-minute-tabs>
</is-land>

There are many [different shapes of configuration file](/docs/config-shapes.md).
34 changes: 34 additions & 0 deletions src/_includes/config/config-shape-callback-export.njk
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{%- set tabid = "configshapes-callback-export" %}
<is-land on:visible import="/js/seven-minute-tabs.js">
<seven-minute-tabs class="tabs-full tabs-flush" persist sync>
{% renderFile "./src/_includes/syntax-chooser-tablist.11ty.js", {id: tabid, only: "jsesm,jscjs"} %}
<div id="{{ tabid }}-jscjs" role="tabpanel">

```js
module.exports = async function(eleventyConfig) {};

module.exports.config = {
dir: {
input: "views",
output: "dist"
}
};
```

</div>
<div id="{{ tabid }}-jsesm" role="tabpanel">

```js
export default async function(eleventyConfig) {};

export const config = {
dir: {
input: "views",
output: "dist"
}
};
```

</div>
</seven-minute-tabs>
</is-land>
24 changes: 24 additions & 0 deletions src/_includes/config/config-shape-callback.njk
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{%- set tabid = "configshapes-callback" %}
<is-land on:visible import="/js/seven-minute-tabs.js">
<seven-minute-tabs class="tabs-full tabs-flush" persist sync>
{% renderFile "./src/_includes/syntax-chooser-tablist.11ty.js", {id: tabid, only: "jsesm,jscjs"} %}
<div id="{{ tabid }}-jscjs" role="tabpanel">

```js
module.exports = async function(eleventyConfig) {
// Access to the full `eleventyConfig` Configuration API
};
```

</div>
<div id="{{ tabid }}-jsesm" role="tabpanel">

```js
export default async function(eleventyConfig) {
// Access to the full `eleventyConfig` Configuration API
};
```

</div>
</seven-minute-tabs>
</is-land>
29 changes: 29 additions & 0 deletions src/_includes/config/config-shape-exportobj.njk
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{%- set tabid = "configshapes-exportobj" %}
<is-land on:visible import="/js/seven-minute-tabs.js">
<seven-minute-tabs class="tabs-full tabs-flush" persist sync>
{% renderFile "./src/_includes/syntax-chooser-tablist.11ty.js", {id: tabid, only: "jsesm,jscjs"} %}
<div id="{{ tabid }}-jscjs" role="tabpanel">

```js
module.exports = {
dir: {
input: "views",
output: "dist"
}
};
```

</div>
<div id="{{ tabid }}-jsesm" role="tabpanel">

```js
export default {
dir: {
input: "views"
}
}
```

</div>
</seven-minute-tabs>
</is-land>
34 changes: 34 additions & 0 deletions src/_includes/config/config-shape-returnobj.njk
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{%- set tabid = "configshapes-returnobj" %}
<is-land on:visible import="/js/seven-minute-tabs.js">
<seven-minute-tabs class="tabs-full tabs-flush" persist sync>
{% renderFile "./src/_includes/syntax-chooser-tablist.11ty.js", {id: tabid, only: "jsesm,jscjs"} %}
<div id="{{ tabid }}-jscjs" role="tabpanel">

```js
module.exports = async function(eleventyConfig) {
return {
dir: {
input: "views",
output: "dist"
}
};
};
```

</div>
<div id="{{ tabid }}-jsesm" role="tabpanel">

```js
export default async function(eleventyConfig) {
return {
dir: {
input: "views",
output: "dist"
}
};
};
```

</div>
</seven-minute-tabs>
</is-land>
30 changes: 30 additions & 0 deletions src/_includes/config/config-templatelangs-api.njk
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{%- set tabid = "config-templatelangs-api" %}
<is-land on:visible import="/js/seven-minute-tabs.js">
<seven-minute-tabs class="tabs-full tabs-flush" persist sync>
{% renderFile "./src/_includes/syntax-chooser-tablist.11ty.js", {id: tabid, only: "jsesm,jscjs"} %}
<div id="{{ tabid }}-jsesm" role="tabpanel">

```js
export default function (eleventyConfig) {
eleventyConfig.setTemplateFormats("html,liquid,njk");

// Or:
// eleventyConfig.setTemplateFormats([ "html", "liquid", "njk" ]);
};
```

</div>
<div id="{{ tabid }}-jscjs" role="tabpanel">

```js
module.exports = function (eleventyConfig) {
eleventyConfig.setTemplateFormats("html,liquid,njk");

// Or:
// eleventyConfig.setTemplateFormats([ "html", "liquid", "njk" ]);
};
```

</div>
</seven-minute-tabs>
</is-land>
Loading

0 comments on commit 3707a85

Please sign in to comment.