Skip to content

Commit 3dd8588

Browse files
Filmbostock
andauthored
document npm update (#1324)
* document framework update closes #1310 * for consistency * Update docs/getting-started.md Co-authored-by: Mike Bostock <[email protected]> * Update docs/getting-started.md Co-authored-by: Mike Bostock <[email protected]> * update all deps --------- Co-authored-by: Mike Bostock <[email protected]>
1 parent f6d94d2 commit 3dd8588

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

docs/getting-started.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,14 @@ This command will ask you a series of questions in order to initialize your new
134134

135135
And that’s it! Your new project is ready to go. 🎉
136136

137+
<div class="note">
138+
139+
Under the hood, this command installs the `@observablehq/framework` package and runs:
140+
141+
<pre>npm exec <span class="win">"</span>@observablehq/framework<span class="win">"</span> -- create</pre>
142+
143+
</div>
144+
137145
## 2. Develop
138146

139147
Next, `cd` into your new project folder.
@@ -550,10 +558,22 @@ json.dump(forecast, sys.stdout)
550558

551559
To write the data loader in R, name it <code>forecast.json.R</code>. Or as shell script, <code>forecast.json.sh</code>. You get the idea. See [Data loaders: Routing](./loaders#routing) for more. The beauty of this approach is that you can leverage the strengths (and libraries) of multiple languages, and still get instant updates in the browser as you develop.
552560

553-
### Deploying automatically
561+
### Deploy automatically
554562

555563
You can schedule builds and deploy your project automatically on commit, or on a schedule. See [deploying](./deploying) for more details.
556564

565+
### Update Framework
566+
567+
To update your project dependencies — in particular when a new [release](https://github.com/observablehq/framework/releases) of Framework is available, `cd` into the project directory and run:
568+
569+
<pre data-copy>npm update</pre>
570+
571+
or
572+
573+
<pre data-copy>yarn upgrade</pre>
574+
575+
(See the reference for <a href="https://docs.npmjs.com/cli/v8/commands/npm-update" target="_blank">npm</a> and <a href="https://classic.yarnpkg.com/lang/en/docs/cli/upgrade/" target="_blank">yarn</a>.)
576+
557577
### Ask for help, or share your feedback
558578

559579
Please reach out if you have questions or thoughts! You can post on the <a href="https://talk.observablehq.com/">Observable forum</a>, start a <a href="https://github.com/observablehq/framework/discussions">GitHub discussion</a>, or file a <a href="https://github.com/observablehq/framework/issues">GitHub issue</a>. And if you like Framework, please give us a star ⭐️ on <a href="https://github.com/observablehq/framework">GitHub</a> — we appreciate your support. 🙏

0 commit comments

Comments
 (0)