SharePoint / SharePoint/spfx

How to use custom repo for SPFx templates?

Open
#247 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area: documentation type: bug
Dominant language
TypeScript
Stars
32
Forks
18
PR merge metrics
No merged PRs in 30d

Description

Description

I know there is this guidance https://github.com/SharePoint/spfx/blob/main/common/docs/creating-a-new-template.md
and the template style guide, but TBH it looks for me like AI generated with a lot of info, which in the end did not help me set up a new repo with my custom templates, which I think should be quite easy 😄.
I have this https://github.com/[Adam-it/spfx-templates](https://github.com/Adam-it/spfx-templates)

But when I try to use my repo either using --template-url option

Image

or pulling it locally and specifying it as --local-source

Image

it, as you can see in the screenshots, does not work.

My question is: how to set it up 🙂?

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 with common/docs/creating-a-new-template.md and the referenced template style guide, then compare their instructions with the Adam-it/spfx-templates repository and the reported --template-url and --local-source attempts. Done means the documentation clearly explains how to structure and invoke a custom template repository successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.