Skip to content

Add minimal path format syntax reference to imports documentation #2097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 4 commits into from
Oct 22, 2025
Merged

Add minimal path format syntax reference to imports documentation #2097

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
87eedd7
Initial plan
Copilot Oct 22, 2025
251b069
Update imports documentation with all supported path formats
Copilot Oct 22, 2025
365da41
Remove deprecated syntax section from imports documentation
Copilot Oct 22, 2025
4b7740a
Minimize imports documentation to just syntax reference
Copilot Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/src/content/docs/reference/imports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,26 @@ Workflow instructions here...
{{#import shared/common-tools.md}}
```

## Path Formats

### Local Paths
- `shared/file.md` - Relative to workflow file
- `../file.md` - Parent directory
- `/absolute/path.md` - Absolute path

### Remote (Workflowspec)
- `owner/repo/path/file.md` - From GitHub repository
- `owner/repo/path/file.md@v1.0.0` - With version tag
- `owner/repo/path/file.md@branch` - With branch
- `owner/repo/path/file.md@sha` - With commit SHA

### Section References
- `file.md#SectionName` - Extract specific section (H1-H3)
- `owner/repo/file.md@v1.0.0#Section` - Remote with section

### Optional Imports
- `{{#import? file.md}}` - Optional (markdown only)

### Import Path Resolution

- **Relative paths**: Resolved relative to the importing file
Expand Down
Loading