--example 标志在创建 NextJs 应用时的意义是什么

Question

I am beginning to learn NextJs and I came across this command to create a new NextJs App

npx create-next-app nextjs-blog --use-npm --example "https://github.com/vercel/next-learn/tree/master/basics/learn-starter"

I wish to know the significance of the --example flag. I could not find any explanation for that.

Answer 1

The --example flag tells create-next-app which template to use. Here's the flag in the source :

  .option(
    '-e, --example [name]|[github-url]',
    `
  An example to bootstrap the app with. You can use an example name
  from the official Next.js repo or a GitHub URL. The URL can use
  any branch and/or subdirectory
`
  )

There's also a note about it in the tutorial :

Under the hood, this uses the tool called create-next-app , which bootstraps a Next.js app for you. It uses this template through the --example flag.