Skip to content

Commit 421f37b

Browse files
committed
Add claude.md with info on the repo structure, to help Claude know where things are
1 parent 4a2e154 commit 421f37b

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

claude.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Quarto Development Guide
2+
3+
## Project Overview
4+
5+
Quarto is an open-source scientific and technical publishing system built on [Pandoc](https://pandoc.org). This repository contains the source code for various parts of the Quarto ecosystem, with the main CLI implementation housed in a separate repository ([quarto-cli](https://github.com/quarto-dev/quarto-cli)).
6+
7+
### Main Components
8+
9+
- **VS Code Extension**: The primary VS Code extension for working with Quarto documents
10+
- **Writer**: A web-based editor for Quarto documents
11+
- **LSP**: Language server for Quarto documents
12+
- **Core Packages**: Shared libraries used across multiple components
13+
14+
## Repository Structure
15+
16+
The repository is organized as a monorepo using Yarn workspaces:
17+
18+
- `apps/`: Contains standalone applications
19+
- `vscode/`: VS Code extension for Quarto
20+
- `writer/`: Web-based Quarto editor
21+
- `lsp/`: Language Server Protocol implementation
22+
- `panmirror/`: WYSIWYG editor component
23+
- `packages/`: Contains shared libraries
24+
- `core/`: Core functionality shared across packages
25+
- `editor-*/`: Editor-related packages
26+
- `quarto-core/`: Quarto-specific core functionality
27+
- Other utility packages
28+
29+
30+
## Additional Resources
31+
32+
- [Quarto Website](https://quarto.org)
33+
- [Extension on Microsoft marketplace](https://marketplace.visualstudio.com/items?itemName=quarto.quarto)
34+
- [Extension on Open VSX Registry](https://open-vsx.org/extension/quarto/quarto)
35+
- [Quarto GitHub Organization](https://github.com/quarto-dev)

0 commit comments

Comments
 (0)