{"repo":"cloud-annotations/docusaurus-openapi","free":true,"listed":false,"github":"https://github.com/cloud-annotations/docusaurus-openapi","clone":"git clone https://github.com/cloud-annotations/docusaurus-openapi.git","description":"🦕 OpenAPI plugin for generating API reference docs in Docusaurus.","language":"TypeScript","stars":536,"topics":["openapi","plugin","docusaurus","hacktoberfest","react","swagger","documentation-generator","openapi3","api-documentation"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"Docusaurus OpenAPI OpenAPI plugin for generating API reference docs in Docusaurus. Quick Overview Coming from v0.1.0 ? See the migration guide. (npx comes with npm 5.2+ and higher) Then open http://localhost:3000/ to see your site. When you’re ready to deploy to production, create a minified bundle with npm run build . Creating a new Site You’ll need to have Node 14.0.0 or later version on your local development machine (but it’s not required on the server). We recommend using the latest LTS version. You can use nvm (macOS/Linux) or nvm-windows to switch Node versions between different projects. To create a new site, you may choose one of the following methods: - ### npx (npx is a package runner tool that comes with npm 5.2+ and higher) - ### npm npm init is available in npm 6+ - ### yarn yarn create is available in Yarn 0.25+ It will create a directory called my-website inside the current folder. Inside that directory, it will generate the initial project structure and install the transitive dependencies: - /docusaurus.config.js - A config file containing the site configuration. This can be used to configure the OpenAPI preset - /openapi.json - The default OpenAPI definition that will be served (path can be configured in docusaurus.config.js ) . For more info see project structure rundown. Once the installation is done, you can open your project folder: Inside the newly created project, you can run some built-in commands: npm start or yarn start Runs the site in development ","default_branch":null,"files":null,"tree":[],"storefront":"/r/cloud-annotations","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/cloud-annotations/docusaurus-openapi/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}