Aquest és un projecte del Observable Framework. Per iniciar el servidor de previsualització local, executa:
npm run dev
Després visita http://localhost:3000 per previsualitzar el teu projecte.
Per a més informació, consulta https://observablehq.com/framework/getting-started.
Un projecte típic del Observable Framework es veu així:
.
├─ src
│ ├─ components
│ │ └─ grafic-super-xulo.js # un mòdul importable
│ ├─ data
│ │ ├─ dades-de-la-api.csv.js # un carregador de dades
│ │ └─ dades.json # un fitxer de dades estàtic
│ ├─ panell.md # una pàgina
│ ├─ informe.md # una altra pàgina
│ └─ index.md # la pàgina principal
├─ .gitignore
├─ observablehq.config.js # el fitxer de configuració del projecte
├─ package.json
└─ README.mdsrc - Aquesta és l'"arrel de fonts" — on viuen els teus fitxers font. Les pàgines van aquí. Cada pàgina és un fitxer Markdown. El Observable Framework utilitza encaminament basat en fitxers, la qual cosa significa que el nom del fitxer controla on es serveix la pàgina. Pots crear tantes pàgines com vulguis. Utilitza carpetes per organitzar les teves pàgines.
src/index.md - Aquesta és la pàgina principal del teu lloc. Pots tenir tantes pàgines addicionals com vulguis, però sempre hauries de tenir també una pàgina principal.
src/data - Pots posar carregadors de dades o fitxers de dades estàtics en qualsevol lloc de la teva arrel de fonts, però recomanem posar-los aquí.
src/components - Pots posar mòduls JavaScript compartits en qualsevol lloc de la teva arrel de fonts, però recomanem posar-los aquí. Això t'ajuda a extreure codi dels fitxers Markdown i posar-lo en mòduls JavaScript, facilitant la reutilització del codi a través de les pàgines, escriure proves, executar linters, i fins i tot compartir codi amb aplicacions web vanilla.
observablehq.config.js - Aquest és el fitxer de configuració del projecte, com ara les pàgines i seccions en la navegació lateral, i el títol del projecte.
| Comanda | Descripció |
|---|---|
npm install |
Instal·la o reinstal·la dependències |
npm run dev |
Inicia el servidor de previsualització local |
npm run build |
Construeix el teu lloc estàtic, generant ./dist |
npm run deploy |
Desplega el teu projecte a Observable |
npm run clean |
Neteja la memòria cau del carregador de dades local |
npm run observable |
Executa comandes com observable help |