Include *.ipynb files and not only *.md files
Open
Nobody has claimed this yet.
C-enhancement
- Dominant language
- Rust
- Stars
- 22.2k
- Forks
- 1.9k
- PR merge metrics
- PR metrics pending
Description
Problem
I want to be able to include *.ipynb files (Jupyter notebook files) in my book. The problem is that mdbook does not recognize these files. We could circonvent this problem by first convert the *.ipynb files into *.md but this is tedious.
Proposed Solution
Being able to include *.ipynb files for free!
Notes
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing how mdBook discovers and includes source files, focusing on the existing *.md handling described in the issue. Check how *.ipynb files are represented and determine the expected inclusion behavior; done means a book can include Jupyter notebook files without a manual conversion step, with tests covering the new file type.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, rust
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100