|
1 | | -# Observable Framework |
| 1 | +[Framework examples →](../) |
2 | 2 |
|
3 | | -This is an [Observable Framework](https://observablehq.com/framework) project. To start the local preview server, run: |
| 3 | +# Framework + GeoTIFF |
4 | 4 |
|
5 | | -``` |
6 | | -yarn dev |
7 | | -``` |
| 5 | +View live: <https://observablehq.observablehq.cloud/framework-example-geotiff/> |
8 | 6 |
|
9 | | -Then visit <http://localhost:3000> to preview your project. |
10 | | - |
11 | | -For more, see <https://observablehq.com/framework/getting-started>. |
12 | | - |
13 | | -## Project structure |
14 | | - |
15 | | -A typical Framework project looks like this: |
16 | | - |
17 | | -```ini |
18 | | -. |
19 | | -├─ src |
20 | | -│ ├─ components |
21 | | -│ │ └─ timeline.js # an importable module |
22 | | -│ ├─ data |
23 | | -│ │ ├─ launches.csv.js # a data loader |
24 | | -│ │ └─ events.json # a static data file |
25 | | -│ ├─ example-dashboard.md # a page |
26 | | -│ ├─ example-report.md # another page |
27 | | -│ └─ index.md # the home page |
28 | | -├─ .gitignore |
29 | | -├─ observablehq.config.js # the project config file |
30 | | -├─ package.json |
31 | | -└─ README.md |
32 | | -``` |
33 | | - |
34 | | -**`src`** - This is the “source root” — where your source files live. Pages go here. Each page is a Markdown file. Observable Framework uses [file-based routing](https://observablehq.com/framework/routing), which means that the name of the file controls where the page is served. You can create as many pages as you like. Use folders to organize your pages. |
35 | | - |
36 | | -**`src/index.md`** - This is the home page for your site. You can have as many additional pages as you’d like, but you should always have a home page, too. |
37 | | - |
38 | | -**`src/data`** - You can put [data loaders](https://observablehq.com/framework/loaders) or static data files anywhere in your source root, but we recommend putting them here. |
39 | | - |
40 | | -**`src/components`** - You can put shared [JavaScript modules](https://observablehq.com/framework/javascript/imports) anywhere in your source root, but we recommend putting them here. This helps you pull code out of Markdown files and into JavaScript modules, making it easier to reuse code across pages, write tests and run linters, and even share code with vanilla web applications. |
41 | | - |
42 | | -**`observablehq.config.js`** - This is the [project configuration](https://observablehq.com/framework/config) file, such as the pages and sections in the sidebar navigation, and the project’s title. |
43 | | - |
44 | | -## Command reference |
45 | | - |
46 | | -| Command | Description | |
47 | | -| ----------------- | -------------------------------------------------------- | |
48 | | -| `yarn install` | Install or reinstall dependencies | |
49 | | -| `yarn dev` | Start local preview server | |
50 | | -| `yarn build` | Build your static site, generating `./dist` | |
51 | | -| `yarn deploy` | Deploy your project to Observable | |
52 | | -| `yarn clean` | Clear the local data loader cache | |
53 | | -| `yarn observable` | Run commands like `observable help` | |
| 7 | +This Observable Framework example demonstrates how to use the [geotiff.js library](https://geotiffjs.github.io/) to read a GeoTIFF file, and then to display it as a raster plot using Observable Plot. The code is in [`src/index.md`](./src/index.md). The example data represents global surface temperatures. |
0 commit comments