{"id":24498226,"url":"https://github.com/nyxb/docux","last_synced_at":"2025-03-15T07:12:37.278Z","repository":{"id":203297423,"uuid":"709276783","full_name":"nyxb/docux","owner":"nyxb","description":"Write beautiful documentations with Nuxt and Markdown.","archived":false,"fork":false,"pushed_at":"2023-11-21T20:50:04.000Z","size":1472,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-21T22:11:27.954Z","etag":null,"topics":["documentation-generator","nuxt","nuxt-theme"],"latest_commit_sha":null,"homepage":"https://docux.dev","language":"Vue","has_issues":true,"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/nyxb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-24T11:49:55.000Z","updated_at":"2024-12-15T08:41:07.000Z","dependencies_parsed_at":"2023-10-27T13:25:30.306Z","dependency_job_id":"f5953188-422d-4681-995a-dfb652ac7075","html_url":"https://github.com/nyxb/docux","commit_stats":null,"previous_names":["nyxb/docux"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nyxb%2Fdocux","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nyxb%2Fdocux/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nyxb%2Fdocux/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nyxb%2Fdocux/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nyxb","download_url":"https://codeload.github.com/nyxb/docux/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243695590,"owners_count":20332629,"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":["documentation-generator","nuxt","nuxt-theme"],"created_at":"2025-01-21T22:10:50.925Z","updated_at":"2025-03-15T07:12:37.248Z","avatar_url":"https://github.com/nyxb.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Docux](https://github.com/nyxb/docux/blob/main/.github/images/docux_repo_picture.png)](https://docux.dev)\n\n## Docux\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![License][license-src]][license-href]\n[![nyxb][nyxb-src]][nyxb-href]\n[![Nuxt][nuxt-src]][nuxt-href]\n[![Volta][volta-src]][volta-href]\n\nDocux is the fastest way to create document-driven websites with Vue \u0026 Markdown.\n\n- [📄 Documentation](https://docux.dev)\n- [⚡️ Play on StackBlitz](https://stackblitz.com/github/nyxb/docux-starter)\n\n## Start a project with Docux\n\nTo get a local copy of the code, use nyxbi cli:\n\n```\nnpx nyxbi init -t themes/docux my-app\n```\n\nIf you want to add Docux to an existing codebase, you can do so with:\n\n- Install the dependency:\n\n```bash\nnpm install docux\n```\n\n- Add it to your extends key in `nuxt.config`:\n\n```ts\ndefineNuxtConfig({\n  extends: 'docux'\n})\n```\n\n## Features ✨\n\n- **+50 Components** ready to build rich pages\n- **Article**, **Docs** and **Blog** layouts\n- Start from a `README`, scale to a framework documentation\n- Table of contents support\n- Configurable design system integration\n- Replace, extend, customize any component in a breeze\n- Leverages [**@nuxt-themes/typography**](https://github.com/nuxt-themes/typography)\n- Used on [Content Documentation](https://content.nuxtjs.org)\n\n## Contributing 🙏\n\n1. Clone this repository\n2. Install dependencies using `pnpm install --frozen-lockfile`\n3. Run `pnpm run prepare` to generate type stubs.\n4. Use `pnpm run dev` to start [docs](./docs) or use `pnpm run play` to start [playground](./playground) in development mode.\n\n## License 📎\n\n[MIT License](./LICENSE)\n\n\u003c!-- Badges --\u003e\n[npm-version-src]: https://img.shields.io/npm/v/docux/latest.svg?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\n[npm-version-href]: https://npmjs.com/package/docux\n\n[npm-downloads-src]: https://img.shields.io/npm/dm/docux.svg?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\n[npm-downloads-href]: https://npmjs.com/package/docux\n\n[license-src]: https://img.shields.io/github/license/nyxb/docux.svg?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\n[license-href]: https://github.com/nyxb/docux/blob/main/LICENSE\n\n[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?\u0026logo=nuxt.js\n[nuxt-href]: https://nuxt.com\n\n[volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg\n[volta-href]: https://volta.net/nyxb/docux?utm_source=readme_docux\n\n[nyxb-src]: https://nyxb.blog/badges/badge-nyxb.svg\n[nyxb-href]: https://nyxb.nexus\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnyxb%2Fdocux","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnyxb%2Fdocux","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnyxb%2Fdocux/lists"}