https://github.com/paloaltonetworks/docusaurus-template-openapi-docs

Docusaurus template for bootstrapping with docusaurus-openapi-docs
https://github.com/paloaltonetworks/docusaurus-template-openapi-docs

documentation docusaurus2 openapi static-site-generator

Last synced: about 2 months ago
JSON representation

Docusaurus template for bootstrapping with docusaurus-openapi-docs

• Host: GitHub
• URL: https://github.com/paloaltonetworks/docusaurus-template-openapi-docs
• Owner: PaloAltoNetworks
• License: mit
• Created: 2022-04-22T18:14:03.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-01T16:19:20.000Z (2 months ago)
• Last Synced: 2024-11-01T17:23:13.714Z (2 months ago)
• Topics: documentation, docusaurus2, openapi, static-site-generator
• Language: TypeScript
• Homepage:
• Size: 1.67 MB
• Stars: 9
• Watchers: 4
• Forks: 16
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Support: SUPPORT.md

Awesome Lists containing this project

README

        
# Template

This template is built for [Docusaurus 3](https://docusaurus.io/), a modern static website generator.

### Usage

```bash

npx [email protected] my-website --package-manager yarn

```

> When prompted to select a template choose `Git repository`.

Template Repository URL:

```bash

https://github.com/PaloAltoNetworks/docusaurus-template-openapi-docs.git

```

> When asked how the template repo should be cloned choose "copy" (unless you know better).

```bash

cd my-website

yarn

```

### Local Development

```bash

yarn start

```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```bash

yarn build

```

This command generates static content into the `build` directory and can be served using any static contents hosting service.