separation of content and code #7

New issue

Open

opened 2025-11-03 17:14:42 +01:00 by puer-robustus · 1 comment

puer-robustus commented

2025-11-03 17:14:42 +01:00

Member

When looking at e.g. the office tech dossier I wonder whether it would be worthwhile to separate the ProjectDescription.text into a separate markdown file, which is then read in the TypeScript code? Or, if TypeScript supports this, even write the complete tech dossier in Markdown with YAML frontmatter, which are then parsed in the app?

This would separate the tech dossier content from its representation and make it more reusable in other contexts, e.g. to create separate handouts as pdfs for specific audiences via e.g. pandoc?

When looking at e.g. the [office tech dossier](https://git.ngi-0.eu/tech-dossiers/ngi0-landing/src/branch/master/src/data/dossiers/office.ts) I wonder whether it would be worthwhile to separate the `ProjectDescription.text` into a separate markdown file, which is then read in the TypeScript code? Or, if TypeScript supports this, even write the complete tech dossier in Markdown with [YAML frontmatter](https://docs.github.com/en/contributing/writing-for-github-docs/using-yaml-frontmatter), which are then parsed in the app? This would separate the tech dossier content from its representation and make it more reusable in other contexts, e.g. to create separate handouts as pdfs for specific audiences via e.g. [pandoc](https://pandoc.org/)?

puer-robustus referenced this issue

2025-11-03 17:19:06 +01:00

Licensing information missing #5

ijohn commented

2025-11-09 20:37:25 +01:00

Owner

I think we can, but I would like to keep this idea on hold. We previously discussed, that the content creation could be done from a GUI editor and stored in a database or a pull request could be created automatically. Maybe we can brainstorm this and pick the best idea

ijohn added the

question

label

2026-06-22 12:44:11 +02:00