livebook-dev/livebook
1
1
Fork 0
mirror of https://github.com/livebook-dev/livebook.git synced 2025-10-10 21:46:46 +08:00
Code Issues Projects Releases Packages Wiki Activity

Minor nits on welcome notebook (#130)

Browse source
This commit is contained in:
José Valim 2021-04-02 14:09:28 +02:00 • committed by GitHub
parent cc9d5a8103
commit 931d55a8b8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
lib/livebook/notebook/welcome.ex
View file

@ -5,7 +5,7 @@ defmodule Livebook.Notebook.Welcome do
## Introduction ## Introduction
We are happy you decided to give Livebook a try, hopefully it empowers We are happy you decided to give Livebook a try, hopefully it empowers
you to build great stuff 🚀 you to build great stuff! 🚀
Livebook is a tool for crafting **interactive** and **collaborative** code notebooks. Livebook is a tool for crafting **interactive** and **collaborative** code notebooks.
It is primarily meant as a tool rapid prototyping - think of it as an IEx session It is primarily meant as a tool rapid prototyping - think of it as an IEx session
@ -27,12 +27,12 @@ defmodule Livebook.Notebook.Welcome do
```elixir ```elixir
# This is an Elixir cell - as the name suggests that's where the code goes. # This is an Elixir cell - as the name suggests that's where the code goes.
# To evaluate this cell, you can either press the "Evaluate" button above # To evaluate this cell, you can either press the "Evaluate" button above
# or use `ctrl + enter` like a boss! # or use `Ctrl + Enter`!
message = "hey, grab yourself a cup of 🍵" message = "hey, grab yourself a cup of 🍵"
``` ```
Subsequent cells have access to the bindings you defined! Subsequent cells have access to the bindings you defined:
```elixir ```elixir
String.replace(message, "🍵", "☕") String.replace(message, "🍵", "☕")
@ -45,7 +45,7 @@ defmodule Livebook.Notebook.Welcome do
## Sections ## Sections
You can leverage so called **sections** to nicely group related cells together. You can leverage so called **sections** to nicely group related cells together.
Click on the book icon in the sidebar to reveal a list of all sections. Click on the "Book" icon in the sidebar to reveal a list of all sections.
As you can see, this approach helps to easily jump around the notebook, As you can see, this approach helps to easily jump around the notebook,
especially once it grows. especially once it grows.
@ -72,7 +72,7 @@ defmodule Livebook.Notebook.Welcome do
Notebooks are stored in **live markdown** format, which is essentially the markdown you know, Notebooks are stored in **live markdown** format, which is essentially the markdown you know,
with just a few assumptions on how particular elements are represented. Thanks to this with just a few assumptions on how particular elements are represented. Thanks to this
approach you can easily keep notebooks under version control and get readable diffs. approach you can easily keep notebooks under version control and get readable diffs.
You can also easily preview those files, reuse for blog posts and even edit in a text editor. You can also easily preview those files, reuse for blog posts, and even edit in a text editor.
## Modules ## Modules
@ -127,7 +127,7 @@ defmodule Livebook.Notebook.Welcome do
By default a new Elixir node is started (similarly to starting `iex`), By default a new Elixir node is started (similarly to starting `iex`),
but you can also choose to run inside a Mix project (as you would with `iex -S mix`) but you can also choose to run inside a Mix project (as you would with `iex -S mix`)
or even manually attach to an existing distributed node! or even manually attach to an existing distributed node!
You can configure the runtime under "Notebook settings". You can configure the runtime by clicking the "Settings" icon on the sidebar.
## Using packages ## Using packages
@ -152,7 +152,7 @@ defmodule Livebook.Notebook.Welcome do
``` ```
```elixir ```elixir
%{elixir: "rulez"} %{elixir: "is awesome"}
|> Jason.encode!() |> Jason.encode!()
|> IO.puts() |> IO.puts()
``` ```