ColivingLiguria

Apply Now

Markdown Style Guide

5 min read

Abstract

This guide outlines the standard formatting and style rules for creating Markdown content within the Coliving Liguria Quartz website. It details the required frontmatter, language separation conventions, and the structural balance between narrative and schematic information.

Markdown Content Style Guide

To maintain consistency across our digital garden, all new notes must adhere to the following structure and style guidelines.

1. Frontmatter

Every file must start with a YAML frontmatter block. This metadata is crucial for Quartz to index and display the content correctly.

Required Fields:

  • date: The creation or last significant update date (YYYY-MM-DD).
  • draft: Set to false for published content, true for work in progress.
  • language: Indicates the languages present (e.g., EN, IT, EN/IT).
  • Filename Rule: If the content is IT/EN (Italian first), the filename MUST be in Italian. If EN/IT (English first), the filename MUST be in English.
  • tags: (Optional) Use English only tags to categorize the content.
---
date: 2025-11-27
draft: false
language: EN/IT
tags: [Example, Documentation]
---

2. The Abstract

Every page must have an Abstract at the beginning of its content section (for each language). This provides a quick summary of the page’s purpose and content.

Format: Use the > [!Abstract] callout syntax.

> [!Abstract]
> 
> This is a concise summary of what this page contains. It helps the reader decide if this is the information they are looking for.

3. Language Separation

We often create bilingual pages. To separate the English section from the Italian section, we use a specific horizontal rule pattern.

Rule:

  1. Language Indicator: The document body must start with a language indicator line: -- Italiano sotto -- (if EN/IT) or -- English below -- (if IT/EN).
  2. First Language: The entire content in the first language follows.
  3. Separator: The two languages are separated by --- (horizontal rule). This rule is reserved exclusively for this purpose.
  4. Second Language: The entire content in the second language follows.
  5. Abstracts: The > [!Abstract] callout must be placed at the beginning of each language section, in the respective language. Do not place a shared abstract at the top.

Format:

-- Italiano sotto --
 
> [!Abstract]
> 
> English abstract here.
 
[English Content]
 
---
 
> [!Abstract]
> 
> Abstract in italiano qui.
 
[Contenuto in Italiano]

4. Headers

  • Hierarchy: Use H1 (#) for the title, H2 (##) for main sections, and H3 (###) for subsections.
  • No Numbering: Do NOT number the headers (e.g., use ## Introduction, not ## 1. Introduction).
  • Capitalization: Use Title Case for English headers and Sentence case for Italian headers.

5. Writing Style

Our content aims for a balance between discursive (narrative, readable) and schematic (bullet points, clear structure).

  • Discursive: Use full sentences to explain context, philosophy, and “why” we do things.
  • Schematic: Use lists, tables, and headers for actionable items, specifications, and “how-to” instructions.

Example:

Discursive: “The kitchen is the heart of the home, designed to foster community interaction through shared meal preparation.” Schematic:

  • Equipment: Industrial stove, 2 fridges.
  • Capacity: 15 people.
  • Rules: Clean as you go.

— Italiano sotto —

Abstract

Questa guida delinea le regole di formattazione e stile standard per la creazione di contenuti Markdown all’interno del sito Quartz di Coliving Liguria. Dettaglia il frontmatter richiesto, le convenzioni di separazione delle lingue e l’equilibrio strutturale tra informazioni narrative e schematiche.

Guida allo Stile dei Contenuti Markdown

Per mantenere la coerenza nel nostro giardino digitale, tutte le nuove note devono aderire alle seguenti linee guida di struttura e stile.

1. Frontmatter

Ogni file deve iniziare con un blocco YAML frontmatter. Questi metadati sono cruciali affinché Quartz indicizzi e visualizzi correttamente il contenuto.

Campi Richiesti:

  • date: La data di creazione o dell’ultimo aggiornamento significativo (AAAA-MM-GG).
  • draft: Impostare su false per contenuti pubblicati, true per lavori in corso.
  • language: Indica le lingue presenti (es. EN, IT, EN/IT).
  • tags: (Opzionale) Usare tag solo in Inglese per categorizzare il contenuto.
---
date: 2025-11-27
draft: false
language: EN/IT
tags: [Example, Documentation]
---

2. L’Abstract

Ogni pagina deve avere un Abstract all’inizio della sua sezione di contenuto (per ogni lingua). Questo fornisce un rapido riassunto dello scopo e del contenuto della pagina.

Formato: Usare la sintassi di callout > [!Abstract].

> [!Abstract]
> 
> Questo è un riassunto conciso di ciò che contiene questa pagina. Aiuta il lettore a decidere se questa è l'informazione che sta cercando.

3. Separazione delle Lingue

Creiamo spesso pagine bilingue. Per separare la sezione inglese da quella italiana, usiamo uno specifico schema di linea orizzontale.

Regola:

  1. Indicatore Lingua: Il corpo del documento deve iniziare con una linea indicatrice: -- Italiano sotto -- (se EN/IT) o -- English below -- (se IT/EN).
  2. Prima Lingua: Segue l’intero contenuto nella prima lingua.
  3. Separatore: Le due lingue sono separate da --- (linea orizzontale). Questa regola è riservata esclusivamente a questo scopo.
  4. Seconda Lingua: Segue l’intero contenuto nella seconda lingua.
  5. Abstract: Il callout > [!Abstract] deve essere posizionato all’inizio di ogni sezione linguistica, nella rispettiva lingua. Non posizionare un abstract condiviso in alto.

Formato:

-- Italiano sotto --
 
> [!Abstract]
> 
> English abstract here.
 
[Contenuto in Inglese]
 
---
 
> [!Abstract]
> 
> Abstract in italiano qui.
 
[Contenuto in Italiano]

4. Stile di Scrittura

Il nostro contenuto mira a un equilibrio tra discorsivo (narrativo, leggibile) e schematico (punti elenco, struttura chiara).

  • Discorsivo: Usare frasi complete per spiegare il contesto, la filosofia e il “perché” facciamo le cose.
  • Schematico: Usare elenchi, tabelle e intestazioni per elementi azionabili, specifiche e istruzioni “how-to”.

Esempio:

Discorsivo: “La cucina è il cuore della casa, progettata per favorire l’interazione comunitaria attraverso la preparazione condivisa dei pasti.” Schematico:

  • Attrezzatura: Cucina industriale, 2 frigoriferi.
  • Capacità: 15 persone.
  • Regole: Pulisci mentre procedi.

Graph View

Backlinks