This is an Observable Framework app. To start the local preview server, run:
yarn dev
Then visit http://localhost:3000 to preview your app.
For more, see https://observablehq.com/framework/getting-started.
A typical Framework project looks like this:
.
├─ src
│ ├─ components
│ │ └─ timeline.js # an importable module
│ ├─ data
│ │ ├─ launches.csv.js # a data loader
│ │ └─ events.json # a static data file
│ ├─ example-dashboard.md # a page
│ ├─ example-report.md # another page
│ └─ index.md # the home page
├─ .gitignore
├─ observablehq.config.js # the app config file
├─ package.json
└─ README.mdsrc - 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, 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.
src/index.md - This is the home page for your app. You can have as many additional pages as you’d like, but you should always have a home page, too.
src/data - You can put data loaders or static data files anywhere in your source root, but we recommend putting them here.
src/components - You can put shared JavaScript modules 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.
observablehq.config.js - This is the app configuration file, such as the pages and sections in the sidebar navigation, and the app’s title.
| Command | Description |
|---|---|
yarn install |
Install or reinstall dependencies |
yarn dev |
Start local preview server |
yarn build |
Build your static site, generating ./dist |
yarn deploy |
Deploy your app to Observable |
yarn clean |
Clear the local data loader cache |
yarn observable |
Run commands like observable help |