Skip to content

Commit

Permalink
Updates to descriptions for catalogue items
Browse files Browse the repository at this point in the history
  • Loading branch information
gilesdring committed Jun 21, 2024
1 parent 6f86c79 commit d6a54a5
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 5 deletions.
3 changes: 3 additions & 0 deletions src/_data.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,8 @@ techniques:
title: Core
- key: data
title: Data
description: |
Data is key to the creation of Lume sites.
Here are some of the techniques we use when dealing with data.
- key: references
title: Links
2 changes: 1 addition & 1 deletion src/_includes/layout/catalogue.vto
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: ./page.vto
---

{{ if description -}}
<p>{{ description }}</p>
{{ description |> md }}
{{- /if }}

{{ comp.layout.Grid({
Expand Down
5 changes: 4 additions & 1 deletion src/index.vto
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,14 @@
title: Home
---
<p>
This site collects some common approaches to building Lume sites in use across Open Innovations.
This is a collection of some common techniques that we at
<a href="https://open-innovations.org/">Open Innovations</a> use
when building websites using the <a href="https://lume.land/">Lume</a>.
</p>

{{ for technique of search.pages('technique', 'order') }}
<h2>{{ technique.title }}</h2>
{{ if technique.description }}{{ technique.description |> md }}{{ /if }}
{{ comp.layout.Grid({
items: technique.catalogue,
renderer: comp.link.Block
Expand Down
9 changes: 9 additions & 0 deletions src/references.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,21 @@ tags: [ technique ]
title: Links
order: 100
layout: layout/catalogue.vto
description: |
The web is full of documentation!
Here are some of the browser tabs we have permanently open.
Most of the answers are within...
catalogue:
- title: Lume
url: https://lume.land/
description: |
Lume is a static site generator which uses the Deno JavaScript runtime.
We use this as the core platform for many of the sites we build.
- title: Lume Discord
url: https://discord.gg/YbTmpACHWB
description: |
For times that the brilliant Lume documentation doesn't have answers,
there's a really active and supportive Discord channel.
- title: Vento
url: https://ventojs.org/
description: |
Expand Down
8 changes: 6 additions & 2 deletions src/techniques.page.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export default function* ({ search, techniques }: Lume.Data & {
// Find all pages that have this technique key set
// Sort by title
const pages = search.pages(`technique=${key}`, "title").map(
({ title, url }) => ({ title, url }),
({ title, url, description }) => ({ title, url, description }),
);

// Yield the page data for this page.
Expand All @@ -40,7 +40,11 @@ export default function* ({ search, techniques }: Lume.Data & {
/**
* Definition of a technique entry
*/
type Technique = { key: string; title: string };
type Technique = {
key: string;
title: string;
description: string;
};

/**
* All pages created by this generator will use the catalogue layout
Expand Down
12 changes: 11 additions & 1 deletion src/techniques/duckdb/index.vto
Original file line number Diff line number Diff line change
@@ -1,9 +1,19 @@
---
title: DuckDB
technique: data
description: |
We use DuckDB as a way of managing larger datasets when building sites.
It also helps us work with other data formats, including Parquet.
---

<p>
<a href="https://duckdb.org">DuckDB</a> is a fast in-process analytical database.
This means it's highly optimised to deal with queries (rather than updates)
and can work incredibly fast on very large datasets.
</p>

<p>
As more data is rendered in a site, the build can slow down significantly.
As more data is rendered in a Lume site, the build can slow down significantly.
It may be beneficial under these circumstances to use DuckDB to access data.
This is particularly true if the data in question is very large or if it is
used to generate very large numbers of pages.
Expand Down

0 comments on commit d6a54a5

Please sign in to comment.