Your First Manuscript: 5-Minute Walkthrough¶
Get from zero to your first scientific PDF in 5 minutes.
Prerequisites¶
- Python 3.11+ installed
- 5 minutes of your time
Step 1: Install and Verify Rxiv-Maker (1 minute)¶
Quick Installation¶
Alternative Installation
Need other installation methods? See the complete installation guide for different platforms and options.
Verify Installation¶
Expected Output:
rxiv-maker v1.6.4
🔍 Checking Python environment... ✅
🔍 Checking LaTeX installation... ✅
🔍 Checking system dependencies... ✅
✅ All systems ready!
Step 2: Create Your First Manuscript (2 minutes)¶
Initialize Project¶
This creates the essential file structure:
my-first-paper/
├── 00_CONFIG.yml # Project configuration
├── 01_MAIN.md # Your main manuscript
├── 02_SUPPLEMENTARY_INFO.md # Optional supplementary content
├── 03_REFERENCES.bib # Bibliography
├── FIGURES/ # Scripts for generating figures
└── output/ # Generated PDFs appear here
Understanding the Structure¶
01_MAIN.md
- Your manuscript content in enhanced Markdown00_CONFIG.yml
- Title, authors, and formatting settings03_REFERENCES.bib
- Academic citations in BibTeX formatFIGURES/
- Python/R scripts that generate figures automatically
Step 3: Write Content (1 minute)¶
Open 01_MAIN.md
in your favorite editor and replace the template with:
# Automated Scientific Publishing with Enhanced Markdown
## Abstract
Scientific writing has evolved significantly with automation tools [@example2023].
This manuscript demonstrates the capabilities of Rxiv-Maker for creating
professional publications efficiently. Our approach leverages enhanced Markdown
syntax to bridge the gap between easy writing and professional LaTeX output.
The automated workflow reduces manuscript preparation time while maintaining
publication quality standards.
## Introduction
Scientific writing has evolved significantly with automation tools [@example2023].
This manuscript demonstrates the capabilities of Rxiv-Maker for creating
professional publications efficiently.
The traditional academic publishing workflow often involves complex LaTeX
formatting and manual figure management. Rxiv-Maker addresses these challenges
by providing an automated pipeline from Markdown to publication-ready PDFs.
## Methods
Our approach leverages enhanced Markdown syntax to bridge the gap between
easy writing and professional LaTeX output. The framework automatically processes
figures from various sources including Python scripts, R scripts, and static images.
The methodology includes:
- Enhanced Markdown with scientific cross-references
- Automated figure generation from Python/R scripts
- Integrated citation management
- Professional LaTeX typesetting
## Results
The automated workflow reduces manuscript preparation time while
maintaining publication quality standards. Key findings include:
- Seamless integration of code and text
- Automated cross-referencing system
- Reproducible figure generation
## Discussion
The results demonstrate that Rxiv-Maker successfully bridges the gap between
ease of use and professional quality output. The system maintains the
simplicity of Markdown while providing the sophistication needed for
academic publishing.
## Conclusion
Rxiv-Maker successfully demonstrates that scientific publishing can be both
efficient and professional. The tool enables researchers to focus on content
rather than formatting complexities.
Step 4: Generate Your PDF (1 minute)¶
What happens: 1. ✅ Validates your manuscript structure 2. ✅ Processes enhanced Markdown syntax 3. ✅ Generates figures from Python scripts 4. ✅ Handles citations and cross-references 5. ✅ Compiles to professional PDF
Your PDF appears in output/my-first-paper.pdf
! 🎉
✅ Success Check¶
You should now have: - ✅ A complete manuscript project structure - ✅ Professional PDF output in output/
folder - ✅ Understanding of the Rxiv-Maker workflow - ✅ Ready to explore advanced features
What's Next?¶
Advanced Features → Learn citations, figure automation, and professional formatting
User Guide → Complete feature documentation
🎓 Learning Path¶
- ✅ You are here: First manuscript (5 minutes)
- Next: Advanced Features
- Then: Daily Workflows (Reference)
- Finally: Team Collaboration (Advanced)