jupyter / jupyter/notebook

Support setting metadata like title, author and date

Open
#791 2 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
13.3k
Forks
5.8k
Avg merge
6d 11h
Merged PRs (30d)
7

Description

Problem

Currently there is no way on the UI to set metadata, such as title, author and date, of a notebook. In consequence, one has to enter such information in the main document, or dedicate one slide to it, using heading 1 for title, sub-headings or paragraphs for author and date. Trouble is, afterwards when s/he wants to convert the notebook to another format, especially PDF, such metadata become part of the main content. In short, the input (notebook) and output (PDF) format are not well aligned.

Suggestion

Support setting metadata like title, author and date in the UI and use them to produce the counterpart in the output format when nbconvert-ing the notebook, so that a document will have a head with title/author/date and slides will have a cover with similarly information.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how notebook metadata is represented in the UI and passed to nbconvert. Check the document and slide output paths, including PDF conversion. Done means title, author, and date can be entered in the UI and appear as document heading metadata or slide-cover information.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
full-stack
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.