HenriquesLab / HenriquesLab/rxiv-maker

VS Code Integration Tutorials

Open
#169 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement good first issue help wanted
Dominant language
Python
Stars
40
Forks
6
Avg merge
7m
Merged PRs (30d)
6

Description

📝 Description
Create a series of written and video tutorials showcasing how to combine rxiv-maker with popular VS Code extensions to maximize productivity when writing scientific papers.

🎯 Motivation
While rxiv-maker already provides excellent manuscript generation capabilities, many researchers use VS Code as their primary editor and could benefit from learning how to leverage the broader VS Code ecosystem alongside rxiv-maker for an enhanced writing experience.

💡 Proposed Content

Tutorial Series with different plugins:

  1. TODO Management
  • Integration with Todo Tree extension
  • Managing research tasks, citations to add, figure improvements, etc.
  • Custom TODO tags for academic writing (e.g., // CITE:, // REVIEW:, // FIGURE:)
  • Enhanced Markdown Editing
  1. Version Control for Papers
  • For example GitLens for git history tracking
  • Git blame
  1. Rainbow CSV / Excel Viewer
  • For looking inside .csv/.xml/.xmlsx files without code or leaving vs code
  1. Other options?

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 reviewing the proposed tutorial topics in issue #169 and defining the scope of the series, including which VS Code extensions are covered and whether each topic needs written and video material. Done means the selected tutorials explain TODO management, Git history and blame, and CSV/XML/XLSX viewing alongside rxiv-maker, with clear academic-writing examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, markdown
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.