New structure: theme/ and template/

[atinux]

This will also fix the deployment, the docs of docus is Docus.

[smarroufin]

@atinux
Taking a step back, it doesn't look right 🤔
What we want is to have the docs folder deployed. Not merging everything together I guess.
It makes sense that /docs/nuxt.config.ts extends: ['../'] and the root content/ only has an index.md as a starter/template. Docs is a playground of the root project.
Still doing it but with some reflexion it looks wrong.

[smarroufin]

And what about docus.dev?

[atinux]

Docus.dev is the demo and documentation of using the theme.

But I agree, we need to discuss about this like @pi0 mentioned in #616

I suggest:

.github/
theme/
  app/
  components/
  composables/
  layouts/
  plugins/
  utils/
  theme.config.ts
  tokens.config.ts
  nuxt.config.ts
template/
  content/
  theme.config.ts
  tokens.config.ts
  nuxt.config.ts # extends: '@nuxt-themes/docus'
.gitignore
.editorconfig
.eslintrc
README.md
package.json

The package.json at root could handle the resolutions for the template/ to work without publishing the package (example on https://github.com/danielroe/nuxt-ionic/blob/main/package.json#L92-L94)

Happy to know your thoughts about this structure @pi0 @danielroe

[pi0]

I like the structure and namings for theme/ and template/!

To handle resolutions, i suggest to opt for native esm feature by setting type: 'module' this way you can refernece to package name without depending on pm (yarn/pnpm/npm) feature.

Sandbox: https://stackblitz.com/edit/github-bcbjjq

[atinux]

Awesome! Thanks for helping @pi0

@smarroufin renaming the issue for this new structure, good for you to update the PR as well?

[smarroufin]

@atinux I guess there will be some things to replug vercel side so it deploys the docs correctly.
Also I think there is no more interest in deploying /theme because it does not contain any pages. Only /template (docs) should be deployed, right?

[pi0]

On second thoughts, if i may have a suggestion, themes could have /example or /demo instead of /template. I'm thinking of more elegant way with nuxi init --theme docus so that some boilerplate can be removed and demo can include some beautiful prefilled content to be deployed with.

Also note that solution i suggested with type: module cannot work if template/package.json exists.

[atinux]

The idea of nuxi init --theme docus is that it will actually copy only the template/ directory that already includes beautiful pre-filled content to be deployed with.

We have to try but I think it works even if we have template/package.json.

Will push on Alpine to avoid breaking docus edge releases.

[atinux]

Just pushed the new structure: https://github.com/nuxt-themes/alpine

It's working well, see online playground: https://stackblitz.com/edit/nuxt-starter-vjbzvt?file=content%2Findex.md