{"id":13506705,"url":"https://github.com/richardeschloss/nuxt-stories","last_synced_at":"2025-04-13T15:34:45.561Z","repository":{"id":49511796,"uuid":"218366987","full_name":"richardeschloss/nuxt-stories","owner":"richardeschloss","description":"Nuxt stories module -- Painless (and now insanely fast) storybooking for Nuxt","archived":false,"fork":false,"pushed_at":"2023-11-08T13:47:49.000Z","size":50819,"stargazers_count":91,"open_issues_count":1,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-27T06:22:57.144Z","etag":null,"topics":["easy","fast","nuxt","painless","stories","storybook"],"latest_commit_sha":null,"homepage":"https://nuxt-stories.netlify.app","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/richardeschloss.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":"richardeschloss","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2019-10-29T19:26:55.000Z","updated_at":"2024-05-28T19:10:26.000Z","dependencies_parsed_at":"2024-01-13T19:23:32.942Z","dependency_job_id":"2dc75380-c20a-4257-a667-ccc9ad699c51","html_url":"https://github.com/richardeschloss/nuxt-stories","commit_stats":{"total_commits":429,"total_committers":2,"mean_commits":214.5,"dds":0.006993006993006978,"last_synced_commit":"7ee5e412db8f8be350ebc5f72f7ada9ccfa84c30"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/richardeschloss%2Fnuxt-stories","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/richardeschloss%2Fnuxt-stories/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/richardeschloss%2Fnuxt-stories/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/richardeschloss%2Fnuxt-stories/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/richardeschloss","download_url":"https://codeload.github.com/richardeschloss/nuxt-stories/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248736248,"owners_count":21153559,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["easy","fast","nuxt","painless","stories","storybook"],"created_at":"2024-08-01T01:00:55.898Z","updated_at":"2025-04-13T15:34:45.534Z","avatar_url":"https://github.com/richardeschloss.png","language":"JavaScript","funding_links":["https://github.com/sponsors/richardeschloss"],"categories":["Uncategorized","JavaScript"],"sub_categories":["Uncategorized"],"readme":"[![npm](https://img.shields.io/npm/v/nuxt-stories)](https://www.npmjs.com/package/nuxt-stories)\n[![npm](https://img.shields.io/npm/dt/nuxt-stories)](https://www.npmjs.com/package/nuxt-stories)\n[![](https://gitlab.com/richardeschloss/nuxt-stories/badges/master/pipeline.svg)](https://gitlab.com/richardeschloss/nuxt-stories)\n[![](https://gitlab.com/richardeschloss/nuxt-stories/badges/master/coverage.svg)](https://gitlab.com/richardeschloss/nuxt-stories)\n[![NPM](https://img.shields.io/npm/l/nuxt-stories)](https://github.com/richardeschloss/nuxt-stories/blob/development/LICENSE)\n\n[📖 **Release Notes**](https://github.com/richardeschloss/nuxt-stories/blob/master/CHANGELOG.md)\n\n# nuxt-stories\n\n\u003e Painless (and now insanely fast) storybooking for Nuxt\n\n## Video overview\n\n\u003cimg src=\"https://raw.githubusercontent.com/richardeschloss/nuxt-stories/feat/nuxt3/public/demo.gif\" style=\"width: 50vw;\" /\u003e\n\n## Features\n* ✅ Insanely fast configuration and usage (one install, one line in config, and you're good to go!)\n* ✅ Live markdown editing and previewing directly on the UI! Faster than Hot Module Reloading!\n* ✅ Stories that get written on the UI get auto saved back to the filesystem (local dev only)\n* ✅ Easily toggle the view mode in the stories header.\n* ✅ Instant compiling of vue components as you type them on the UI!\n* ✅ Ordering of stories using story frontMatter.\n* ✅ Instant updating of table of contents as you type the headers\n* ✅ Auto importing of components. Just place components in your components directory and just use them!\n* ✅ Emoji support! Don't believe it? Just look at this bulleted list!\n* ✅ Built-in json viewer. Just type `\u003cjson :data=\"[your data]\"/\u003e` to see the tree.\n* ✅ The perfect development tool for rapidly jotting down notes, gameplans, or even writing official documentation! Documentation that is also *functional*. \n* ✅ Built-in fetch. Quickly fetch on the client or server side, right in your story! (v2.0.13+)\n* ✅ Component-browser and style-editor with direct tie-in to Google fonts.\n\n## Demo\nSee it in ACTION: [DEMO @ Netlify](https://nuxt-stories.netlify.com) (Ctrl+Click for new tab)\n\n## Setup\n\n1. Add `nuxt-stories` dependency to your project\n\n* Nuxt 3.x\n```bash\nnpm i -D nuxt-stories@next\n```\n\n* Nuxt 2.x\n```bash\nnpm i -D nuxt-stories\n```\n\nYou may also need to install the following deps if they didn't get installed when you first created your nuxt app:\n\nAfter installing, a postinstall script will run to \"gently copy\" sample stories, assets, and layout(s) to your workspace to get you setup asap.  It will also create a \"components\" directory if it doesn't already exist.\n\n2. Add `nuxt-stories` to the `buildModules` section of `nuxt.config.js`\n\n```js\n{\n  buildModules: [\n    'nuxt-stories'\n  ],\n  stories: {\n    /* stories options here */\n  }\n}\n```\n\n3. There is no step 3! You're good to go! Try it out!\n\n```bash\nnpm run dev\n```\n\n\u003e Then view your stories running on your local dev server: http://localhost:3000/stories\n\nAll the stories that you edit there will get auto saved back to [project root]/stories/[language]. Read on to learn more. More explanation will follow.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frichardeschloss%2Fnuxt-stories","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frichardeschloss%2Fnuxt-stories","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frichardeschloss%2Fnuxt-stories/lists"}