Saltar al contenido
fastpad
Documentación

Markdown y exportación

Una única serialización canónica, con anclas de bloque, usada por la exportación, la API, las herramientas de los agentes y la copia en disco.

El formato

CommonMark, con frontmatter YAML para los metadatos de la nota y un ancla {#blockId} después de cada bloque.

markdown
---
title: Retrieval design
types: [Project]
status: active
---

# Retrieval design {#01JB2K7Q9XN4M8YV3TD0FZ5ERW}

Four arms, fused by weighted RRF. {#01JB2K7Q9XN4M8YV3TD0FZ5ESX}

- lexical {#01JB2K7Q9XN4M8YV3TD0FZ5ETY}
- dense {#01JB2K7Q9XN4M8YV3TD0FZ5EUZ}

El ancla es lo importante. Es lo que hace que un archivo Markdown sea una representación fiel del documento y no una impresión suya: el archivo dice qué bloque es cada párrafo, así que los cambios hechos en disco vuelven a su sitio exacto.

La copia en disco

bash
fp pull ./notes            # write the mirror
$EDITOR ./notes/…
fp push ./notes --dry-run  # see what would change, offline
fp push ./notes            # send it back

Un push es una diferencia contra identificadores conocidos, nunca una conjetura: un ancla cuyo texto cambió es una edición de ese bloque; un ancla que desapareció es un borrado; un párrafo sin ancla es algo nuevo.

Los nombres de archivo se construyen a partir del título de cada nota después de enmascarar cualquier credencial y neutralizar cualquier URL que contenga, sea quien sea quien descargue, así que una clave pegada en un título nunca se convierte en el nombre de un archivo en disco. El identificador de la nota forma parte del nombre, así que dos notas con el mismo título son dos archivos.

Notas publicadas

Publicar una nota la hace legible en fastpad.ai/n/{id} sin cuenta. La misma URL sirve HTML a un navegador y Markdown a cualquier cosa que lo pida.

bash
curl -H 'Accept: text/markdown' https://www.fastpad.ai/n/01JB2K…

Solo una persona con sesión iniciada puede publicar — ninguna credencial de agente puede, porque un agente capaz de publicar podría exfiltrar un espacio de trabajo haciéndolo público y leyéndolo desde fuera. Para quien llama sin credenciales, una nota no publicada, una borrada y una que nunca existió son indistinguibles.

Qué sobrevive a la ida y vuelta

  • Encabezados, párrafos, listas, tareas, citas, avisos, bloques de código, separadores.
  • Tablas, incluidas las celdas con una barra vertical escapada.
  • Enlaces, menciones y las aristas que hay detrás.
  • Las propiedades de la nota, como frontmatter.
  • Los identificadores de bloque, en todo.

Los adjuntos se referencian por URL en lugar de incrustarse. Una exportación es un directorio de texto que puedes leer con cualquier cosa, que es la prueba que este formato existe para superar.

Leer como Markdown