Make the docs landing page more friendly (include simple template example)
See original GitHub issueI’m new to copier, but it looks this sentence in docs may need correction:
If a YAML file named copier.yml is found in the root of the project (alternatively, a YAML file named copier.yaml), the user will be prompted to fill in or confirm the default values.
https://copier.readthedocs.io/en/stable/creating/
Also substituting values seems a part of core logic of copier, yet there is nothing about it on the front page of the docs. You provide for copying examples (like shutil.copy
), but the user like myself is more interested how to provide custom values for package name, author etc. It would be great if starting examples helped with that.
Issue Analytics
- State:
- Created 3 years ago
- Reactions:2
- Comments:8 (5 by maintainers)
Top Results From Across the Web
21 of the Best Landing Page Design Examples You Need to ...
Looking to up your landing page game? Here are 21 great landing pages, why they're great, and how you can use the same...
Read more >Landing Page Templates For WordPress (With Examples)
Looking for some cool landing page templates for Wordpress? This post has all the examples and templates you need.
Read more >Marketo Guided Landing Page Template How-To's - Digital Pi
Here we'll have a look via step-by-step tutorial at how to: Create a New Marketo Guided Landing Page Template; Add some pre-written ...
Read more >How to Use Liquid to Create Custom Landing Page Templates
Creating a custom page template. The first step to creating a landing page for your theme is to create a unique Liquid template...
Read more >How to create a landing page in Google docs in 2022 - YouTube
Your browser can't play this video. Learn more. Switch camera.
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
My idea of what people look at on the first page: oh, it is a coockiecutter alternative? Is it easy to use? How can I mark the template? How can I provide the values to fill? Are there any special behaviours?
Similar page: https://cookiecutter.readthedocs.io/en/1.7.2/first_steps.html#your-first-cookiecutter
I just looked at the
copier
tag/topic on GitHub, and I wonder ifcopier-template
would not be better, because there are quite a number of unrelated projects using thecopier
tag. I’m already using both of them in my templates, as well ascopier-extension
for my Copier+Jinja extension.EDIT: my bad, the README already suggests using
copier-template
🙂