| title | Welcome to Paperguide Documentation |
|---|---|
| description | An overview of Paperguide, a platform for organizing and managing project documentation spaces. |
Paperguide helps you create and manage documentation spaces for your projects. You organize content into structured pages, collaborate with teams, and publish professional docs with ease. Use it to centralize guides, APIs, and tutorials without complex setups.
Paperguide offers powerful tools to streamline your documentation workflow.
Create unlimited documentation spaces for different projects. Organize pages with folders and hierarchies. Write in Markdown with live previews. Embed components like code blocks and diagrams directly. Invite team members, review changes, and track versions in real time. Start with a free space to test features. Upgrade for custom domains and advanced analytics.You gain faster onboarding for new team members, reduced support tickets, and a single source of truth for your docs. Teams report 40% less time spent answering repeated questions.
Follow these steps to set up your first Paperguide space.
Visit paperguide.com and sign up with your email or GitHub account. Click "New Space" and name it for your project, like "MyApp Docs". Create your first page. Use the editor to add headings, lists, and components. Make your space public or share a private link with your team.Customize your integration based on your stack.
Connect your repo for automatic syncs.<CodeGroup tabs="YAML,CLI">
```yaml
# .github/workflows/docs.yml
name: Deploy Docs
on: [push]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Deploy to Paperguide
run: curl -X POST https://api.paperguide.com/deploy \
-H "Authorization: Bearer YOUR_TOKEN" \
-d '{"repo": "your/repo"}'
```
```bash
# Install CLI
npm install -g @paperguide/cli
paperguide login
paperguide deploy ./docs
```
</CodeGroup>
```bash
npm install paperguide-docs
```
```javascript
import { PaperguideEmbed } from 'paperguide-docs';
function DocsViewer() {
return (
<PaperguideEmbed spaceId="your-space-id" />
);
}
```
<ParamField path="spaces" param-type="GET" required="true">
List all your documentation spaces.
</ParamField>
<ParamField header="Authorization" param-type="string" required="true">
Bearer `{YOUR_API_TOKEN}`.
</ParamField>