Support setting a base URL for `data-include`
Open
Nobody has claimed this yet.
Feature request
- Dominant language
- JavaScript
- Stars
- 806
- Forks
- 434
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 32
Description
When building specs with data-include, it would be helpful be able to dynamically set a dataIncludeBase URL in respecConfig. This could help:
- add
data-includesupport with pr-preview (See https://github.com/w3c/respec/issues/4480, https://github.com/tobie/pr-preview/issues/144), - give us ability to use different versions of data-include at same path (say using different commit as preview).
- Also in docs at respec.org, we set the absolute
data-includeURL as apreProcessscript to avoid duplication as well as being able to edit locally (using a localhost static server in cloned wiki).
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 locating the data-include handling and respecConfig processing in the Respec codebase, then compare them with the referenced preProcess example in respec-web-services. The change is done when a configured dataIncludeBase URL can support pr-preview, alternate versions at the same path, and local editing without requiring the existing workaround.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100