Quickstart
This guide walks you through the core Margin workflow: create a notebook, run code, and share your findings in a brief.
Step 1: Create a Notebook
- From your dashboard, click Notebooks in the sidebar
- Click New notebook
- Choose Blank notebook or upload an existing
.ipynbfile
You'll see a fresh notebook with one empty code cell.
Step 2: The Kernel Connects Automatically
The Python kernel connects automatically when you open a notebook. Watch the toolbar—the status shows:
- Connecting... → Establishing the connection
- Warming up... → Loading Python packages
- Kernel ready (green) → Ready to execute code
Step 3: Write and Run Code
Type some Python in the first cell:
import pandas as pd
# Create sample data
data = {
'Month': ['Jan', 'Feb', 'Mar', 'Apr'],
'Revenue': [12000, 15000, 13500, 18000]
}
df = pd.DataFrame(data)
df
Run the cell with Shift + Enter (or click the play button). You'll see the DataFrame rendered below the cell.
Add More Cells
- Press B to add a cell below (or A for above)
- Press M to convert a cell to Markdown
- Press Y to convert back to code
Keyboard Shortcuts
Margin notebooks support Jupyter‑style shortcuts:
| Key | Action |
|---|---|
Shift+Enter | Run cell and advance |
Ctrl/Cmd+Enter | Run all cells |
B | Insert cell below |
A | Insert cell above |
DD | Delete cell |
M | Change to Markdown |
Y | Change to code |
J/K or arrows | Navigate cells |
Step 4: Save Your Notebook
Margin auto‑saves as you work. The status indicator in the navbar shows:
- Unsaved – Changes pending
- Syncing... – Save in progress
- Synced – All changes saved
You can also press Ctrl/Cmd + S to save immediately.
Step 5: Create a Brief
Now let's share your findings:
- Click Briefs in the sidebar
- Click New brief
- Give it a title (e.g., "Q1 Revenue Summary")
- Optionally, link it to your notebook (this enables artifact embedding)
- Click Create brief
You'll land in the brief editor—a rich text editor for writing your narrative.
Step 6: Add Artifacts
If your brief is linked to a notebook, you can embed outputs directly:
- Click Insert Artifact in the toolbar (or type
/and select "Artifact from Notebook") - Choose a cell output (chart, table, or image)
- The artifact appears in your brief, linked to its source
Step 7: Share Your Brief
Ready to publish?
- Click the Share button in the brief editor
- Toggle Public to on
- Set a URL slug (e.g.,
q1-revenue) - Copy the public link
Your brief is now live at marginfordata.com/@username/briefs/q1-revenue.
Viewers see your narrative and embedded outputs—but not your raw data or notebook code.
What's Next?
- Learn about notebooks – Cells, outputs, and kernel features
- Learn about briefs – Editing, artifacts, and formatting
- Upload datasets – Work with your own data
- Sharing guide – Public profiles and privacy controls