{"id":13451869,"url":"https://github.com/boyney123/generator-create-docusaurus","last_synced_at":"2025-04-07T11:32:01.928Z","repository":{"id":57246819,"uuid":"189573636","full_name":"boyney123/generator-create-docusaurus","owner":"boyney123","description":"A generator for new docusaurus projects.","archived":false,"fork":false,"pushed_at":"2019-11-01T13:51:13.000Z","size":9951,"stargazers_count":14,"open_issues_count":2,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-22T17:11:26.449Z","etag":null,"topics":["documentation","docusaurus","generator","yeoman"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/generator-create-docusaurus","language":"JavaScript","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/boyney123.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-05-31T10:11:45.000Z","updated_at":"2023-07-18T18:30:11.000Z","dependencies_parsed_at":"2022-08-24T16:50:22.587Z","dependency_job_id":null,"html_url":"https://github.com/boyney123/generator-create-docusaurus","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boyney123%2Fgenerator-create-docusaurus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boyney123%2Fgenerator-create-docusaurus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boyney123%2Fgenerator-create-docusaurus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boyney123%2Fgenerator-create-docusaurus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boyney123","download_url":"https://codeload.github.com/boyney123/generator-create-docusaurus/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247644343,"owners_count":20972267,"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","docusaurus","generator","yeoman"],"created_at":"2024-07-31T07:01:05.262Z","updated_at":"2025-04-07T11:31:56.919Z","avatar_url":"https://github.com/boyney123.png","language":"JavaScript","funding_links":["https://www.paypal.me/boyney123/5"],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n\u003ch2\u003e⚡ generator-create-docusaurus: quickly create documentation websites ⚡.\u003c/h2\u003e\n\u003cp\u003eUse this generator to quickly get up and running with a documentation website for your project.\u003c/p\u003e\n\n  \u003chr /\u003e\n\n[![MIT License][license-badge]][license]\n[![PRs Welcome][prs-badge]][prs]\n[![Version][version-badge]][version]\n[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors)\n\n[![Watch on GitHub][github-watch-badge]][github-watch]\n[![Star on GitHub][github-star-badge]][github-star]\n\n[Donate ☕](https://www.paypal.me/boyney123/5)\n\n\u003chr /\u003e\n\n\u003cimg alt=\"header\" src=\"./images/demo.gif\" /\u003e\n\n  \u003ch3\u003eFeatures: Setup within minutes, feature examples, docs example and more...\u003c/h3\u003e\n\n\u003c/div\u003e\n\n\u003chr/\u003e\n\n# The problem\n\nWhen building tools \u0026 APIS for developers it is important that we write some documentation on how to use it.\n\n[Docusaurus](https://docusaurus.io/) is a great tool to help building documentation websites, but you still have to edit various files to get it ready for production.\n\nThis project was created to bootstrap your documentation website.\n\n# This solution\n\nThis project uses [Docusaurus](https://docusaurus.io/) combined with [yeoman](https://yeoman.io/) to enable the rapid spin up of documentation websites.\n\nThis project was inspired and uses code from:\n\n- [create-react-app](https://github.com/facebook/create-react-app)\n- [Kent C. Dodds open source generator](https://github.com/kentcdodds/generator-kcd-oss)\n- [Sindresorhus node generator](https://github.com/sindresorhus/generator-nm)\n\n# Getting Started\n\n_Make sure you have yeoman installed_\n\n```sh\nnpm install -g yo\n```\n\n## Installing the generator\n\n```sh\nnpm install -g generator-create-docusaurus\n```\n\n## Running the generator\n\nCreate your new documentation directory and run this command within it\n\n```sh\n  yo create-docusaurus\n```\n\nOnce everything is installed go to [http://localhost:3000](http://localhost:3000) to see your new documentation website!\n\n# Contributing\n\nIf you have any questions, features or issues please raise any issue or pull requests you like.\n\n[license-badge]: https://img.shields.io/github/license/boyney123/generator-create-docusaurus.svg?color=yellow\n[license]: https://github.com/boyney123/generator-create-docusaurus/blob/master/LICENSE\n[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\n[prs]: http://makeapullrequest.com\n[version-badge]: https://img.shields.io/npm/v/generator-create-docusaurus.svg?color=green\n[version]: https://www.npmjs.com/package/generator-create-docusaurus\n[github-watch-badge]: https://img.shields.io/github/watchers/boyney123/generator-create-docusaurus.svg?style=social\n[github-watch]: https://github.com/boyney123/generator-create-docusaurus/watchers\n[github-star-badge]: https://img.shields.io/github/stars/boyney123/generator-create-docusaurus.svg?style=social\n[github-star]: https://github.com/boyney123/generator-create-docusaurus/stargazers\n\n# Donating\n\nIf you find this tool useful, feel free to buy me a ☕ 👍\n\n[Buy a drink](https://www.paypal.me/boyney123/5)\n\n# License\n\nMIT.\n\n## Contributors\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore --\u003e\n\u003ctable\u003e\u003ctr\u003e\u003ctd align=\"center\"\u003e\u003ca href=\"https://medium.com/@boyney123\"\u003e\u003cimg src=\"https://avatars1.githubusercontent.com/u/3268013?v=4\" width=\"100px;\" alt=\"David Boyne\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eDavid Boyne\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/boyney123/mockit/commits?author=boyney123\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/boyney123/mockit/commits?author=boyney123\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#design-boyney123\" title=\"Design\"\u003e🎨\u003c/a\u003e \u003ca href=\"#ideas-boyney123\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"#review-boyney123\" title=\"Reviewed Pull Requests\"\u003e👀\u003c/a\u003e \u003ca href=\"#tool-boyney123\" title=\"Tools\"\u003e🔧\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboyney123%2Fgenerator-create-docusaurus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboyney123%2Fgenerator-create-docusaurus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboyney123%2Fgenerator-create-docusaurus/lists"}