feat(document-driven): add document-driven as a @nuxt/content feature

[Tahul]

❓ Type of change

• 👌 Enhancement (improving an existing functionality like performance)
• ✨ New feature (a non-breaking change that adds functionality)

📚 Description

This PR adds documentDriven as a new feature for the module.

This feature basically is a more generic approach than @docus/base.

It offers more flexibility while preserving the same features as a default.

Here is a preview from the config object:

const defaultDocumentDrivenConfig = {
  // Will fetch page globally
  page: true,
  // Will fetch navigation globally
  navigation: true,
  // Will fetch surround globally
  surround: true,
  // `globals` key definition
  globals: {
    // Will fetch `_theme.yml` and put it in `globals.theme`
    theme: {
      where: [
        {
          _id: 'content:_theme.yml'
        }
      ],
      without: ['_']
    }
  },
  // Will use `theme` global to fallback on layout resolution
  layoutFallbacks: ['theme'],
  // Will inject pre-configured `[...slug].vue` page
  injectPage: true
}

These datas becomes globally available via the useDocumentDriven() composable:

const { page, navigation, surround, globals } = useDocumentDriven()

I updated the documentation with new pages:

/guide/writing/document-driven
/api/composables/use-document-driven
/api/composables/use-content-helpers
/api/configuration (new content)
/examples/document-driven/hello-world (new example)

This PR also deeply refactors the playground/ and test/ directories.

You can now run scoped playground with these commands:

yarn dev => `playground/basic`
yarn dev basic => `playground/basic`
yarn dev document-driven => `playground/document-driven`

Same applies to test:

yarn test => `Run all test suite`
yarn test basic => `basic.test.ts`
yarn test module => `module.test.ts`
yarn test document-driven => `document-driven.test.ts`

Any feedback to the API or implementation is more than welcome!

📝 Checklist

• I have updated the documentation accordingly.

TODO:

• Write test suite (fixture ready, tests not written yet)
• Review by @farnabaz @Atinux @benjamincanac

[netlify]

✅ Deploy Preview for nuxt-content ready!

Name	Link
🔨 Latest commit	7c8650a
🔍 Latest deploy log	https://app.netlify.com/sites/nuxt-content/deploys/62b4907587a6b2000854b966
😎 Deploy Preview	https://deploy-preview-1279--nuxt-content.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[Atinux]

Beautiful work @Tahul ❤️

I think we could go with

const { page, navigation, surround, globals } = useContent()

And warn to say that this composable is available only with content.documentDrivent mode activated.

[Tahul]

Beautiful work @Tahul ❤️

I think we could go with

const { page, navigation, surround, globals } = useContent()

And warn to say that this composable is available only with content.documentDrivent mode activated.

yaaaay! 🚀

Pushing that really soon!

[Tahul]

@Atinux ; I renamed useDocumentDriven into useContent :)

WDYT about merging this feature?

[Atinux]

I would like to have also a review from @farnabaz

[Atinux]

I think you can also rename the composable filename @Tahul

[farnabaz]

LGTM 👍