Docs
Okay, so there's no "real" documentation yet 😅
But hear me out.
As an indie developer I only have so much bandwidth.
Right now I'm focusing on adding new modules and features, fixing bugs, and streamlining the DX.
I've included basic installation and configuration options below. The playgrounds in each module let you see what they're capable of.
Because things are still in flux, I want to avoid writing and rewriting the docs a over and over until things are more stable. I want to optimize for product evolution.
Will it be this way in the long term? Absolutely not.
But for the next few months this is my approach. The full docs will come eventually.
In the meantime, you have full access to modern tooling (e.g. IntelliSense, auto complete, etc.) because Nuxtify is written in Typescript. This creates a basic form of documentation right in your code editor.
Thank you for your understanding 🙂
- David
PS: If you want 1:1 help getting set up and running with Nuxtify, please reach out. I'd be happy to hop on a quick call to get you started. It's free and isn't a sales call. My goal is to better understand where there's friction and meet the humans using what I built.
Installation
For the full instructions see the README of each module. In short, you need to install the Nuxt module, then configure it. You can then use any of the auto-imported composables and components, just like you would your own.
Install
npx nuxt module add @nuxtify/cms
Configure
// nuxt.config.ts
export default defineNuxtConfig({
modules: ["@nuxtify/cms"],
nuxtifyCms: {
/* module specific options */
},
});
Demo Playground
Each module has a demo playground so you can see the different components and configuration options.
There is a link at the top the README in each module to a StackBlitz playground. This means you can demo it without downloading anything.
For example, this is the demo playground for Nuxtify Core: https://stackblitz.com/github/nuxtify-dev/core?file=playground%2Fapp.vue
Just click the link, wait for it to install the dependencies and start the dev server, then have a play!
Local Demo
If you prefer to run the playground locally (or of StackBlitz isn't working), follow these steps:
- Clone the repo.
npm inpm run dev