deploy test

This commit is contained in:
miloschwartz
2025-07-31 14:45:36 -07:00
parent 3556d40d47
commit b918f105b5
64 changed files with 3397 additions and 1943 deletions

100
index.mdx
View File

@@ -1,97 +1,43 @@
---
title: "Introduction"
description: "Welcome to the new home for your documentation"
title: "Introduction to Pangolin"
---
## Setting up
Pangolin is an open source and self-hostable tunneled reverse proxy server with identity-aware access control. Think self-hosted Cloudflare Tunnels.
Get your documentation site up and running in minutes.
<Card
title="Start here"
icon="rocket"
href="/quickstart"
horizontal
>
Follow our three step quickstart guide.
<Card img="/images/fossorial-dashboard.png">
Screenshot of resources page from the Pangolin Dashboard.
</Card>
## Make it yours
Pangolin establishes secure connections from edge networks to cloud exit nodes, bypassing the need for public inbound ports and complex firewall configurations. Pangolin is incredibly useful for exposing local services, IoT devices, or internal applications to the internet without direct exposure, enhancing security by reducing attack surface and simplifying network management. Additionally, Pangolin acts as an identity-aware proxy by authenticating every request against admin-defined access controls and rules.
Design a docs site that looks great and empowers your users.
<Columns cols={2}>
<Card title="How it works" icon="map" href="/about/how-pangolin-works">
Learn how the Pangolin system works from the server to the edge network.
</Card>
<Card title="Use cases" icon="brain" href="/about/how-pangolin-works">
Learn about the many different ways you can use Pangolin's capabilities.
</Card>
</Columns>
<Columns cols={2}>
<Card
title="Edit locally"
icon="pen-to-square"
href="/development"
title="Self-host Pangolin"
icon="server"
href="/self-host/quick-install"
>
Edit your docs locally and preview them in real time.
Install and manage the Pangolin server on your own infrastructure.
</Card>
<Card
title="Customize your site"
icon="palette"
title="Install Newt"
icon="sitemap"
href="/essentials/settings"
>
Customize the design and colors of your site to match your brand.
</Card>
<Card
title="Set up navigation"
icon="map"
href="/essentials/navigation"
>
Organize your docs to help users find what they need and succeed with your product.
</Card>
<Card
title="API documentation"
icon="terminal"
href="/api-reference/introduction"
>
Auto-generate API documentation from OpenAPI specifications.
Install Newt, the edge client, almost anywhere.
</Card>
</Columns>
## Create beautiful pages
## What is a fossorial animal?
Everything you need to create world-class documentation.
The Pangolin system is made up of many components, all with unique animal names. These animals are called fossorial animals.
<Columns cols={2}>
<Card
title="Write with MDX"
icon="pen-fancy"
href="/essentials/markdown"
>
Use MDX to style your docs pages.
</Card>
<Card
title="Code samples"
icon="code"
href="/essentials/code"
>
Add sample code to demonstrate how to use your product.
</Card>
<Card
title="Images"
icon="image"
href="/essentials/images"
>
Display images and other media.
</Card>
<Card
title="Reusable snippets"
icon="recycle"
href="/essentials/reusable-snippets"
>
Write once and reuse across your docs.
</Card>
</Columns>
## Need inspiration?
<Card
title="See complete examples"
icon="stars"
href="https://mintlify.com/customers"
>
Browse our showcase of exceptional documentation sites.
</Card>
A fossorial animal is one adapted to digging which lives primarily but not solely, underground. Some examples are badgers, naked mole-rats, clams, meerkats, and mole salamanders, as well as many beetles, wasps, and bees.