jupyter / jupyter/nbformat

Document (in Sphinx) our markdown spec

Open
#96 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
313
Forks
176
PR merge metrics
No merged PRs in 30d

Description

This is a part of this overall project:

https://github.com/jupyter/nbformat/projects/1

and is a follow on to #95 that will create a sample notebook. In this issue we need to write documentation in the nbformat repo using Sphinx about the markdown we support. That guide should take CommonMark as a starting point and describe what we do and don't support as well as other extensions.

@ashutoshbondre @mpacer

Contributor guide

Open the contributing guide

Research direction

Review issue #95 and the nbformat repository's existing Sphinx documentation, then use CommonMark as the reference point. Document which Markdown features nbformat supports, which it does not, and its other extensions; the guide is done when those differences and extensions are clearly described.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 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.