Documentation

Getting Started

What InkRider is, how to open it in Word, and how to run your first code.

What InkRider Is

InkRider lets you write Python in Word and use the result directly in the document you are working on. It is built for practical document work: generating text, tables, computed values, and other structured output without bouncing between Word and a separate notebook window.

Use InkRider when you want to:

  • compute values inside the document workflow
  • generate text or structured content using Python code
  • mix code, markdown, and Word authoring in one working session

Before You Start

Make sure you have:

  • an InkRider account
  • a supported Word client
  • access to the Word add-in surface you intend to use

InkRider is designed for:

  • Word for Windows
  • Word for Mac
  • Word Online

Install and Open the Add-in

  1. Open Microsoft Word.
  2. Go to Insert → Add-ins (or Insert → Get Add-ins on some clients).
  3. Search for InkRider and add it.
  4. Open the InkRider task pane from the ribbon or the Add-ins menu. The add-in appears as a panel beside your document.

If your organization manages add-ins centrally, ask your IT administrator to deploy InkRider to your tenant.

Sign In

The first time you open InkRider, you are prompted to sign in:

  1. Enter the email and password for your InkRider account.
  2. If you do not have an account yet, use Create account to register.
  3. After sign-in, your plan status is visible in the add-in header.

If sign-in fails, see Troubleshooting or contact support.

Basic Workflow

  1. Open Microsoft Word and your document.
  2. Open the InkRider add-in.
  3. Sign in.
  4. Click New → Notebook to create a notebook.
  5. Write Python in the first cell.
  6. Run the cell (Shift+Enter).
  7. Anchor the output to a location in your Word document (optional but recommended for live documents).
  8. Save the document.

New to notebooks? Continue with Notebook Basics for a full walkthrough of cells, run order, and anchoring.

A Minimal First Example 

total = 12
unit_price = 4.5
grand_total = total * unit_price

grand_total

Start with something that proves the loop works:

  • enter the code in a notebook cell
  • run it
  • confirm the result appears in the output area below the cell
  • anchor the result into the document when you are ready

First-Time Runtime Note

The first time you run code in a session, InkRider downloads runtime components for the in-browser environment. This can take 30–60 seconds. Later runs in the same session are much faster.

If code never runs or the session appears stuck after waiting, see JupyterLite Runtime and Troubleshooting.

What To Test First

When you are validating a new build, check these first:

  • the add-in opens correctly in Word
  • you can create a notebook and run a simple cell
  • the output is readable in the add-in panel
  • anchoring inserts output into the document (see Cell Anchoring)
  • sign-in and account state behave as expected

Where To Go Next