Skip to content

configuration.mdx

Latest commit

 

History

History
133 lines (112 loc) · 3.89 KB

configuration.mdx

File metadata and controls

133 lines (112 loc) · 3.89 KB
title Configuration and Customization
description Customize your Paperguide documentation space with themes, permissions, and export options.

Overview

Customize Paperguide to match your brand and control access. Configure themes with your colors, manage user permissions, and export docs for publishing. Start with the dashboard settings panel to apply changes instantly.

Save your configuration in a `paperguide.config.json` file for version control and team sharing. Apply custom colors and logos. Control who edits and views docs. Generate static sites or PDFs.

Branding and Themes

Tailor the visual identity of your Paperguide space. Set primary colors, logos, and fonts via the settings menu or config file.

Navigate to **Space Settings > Themes**. Enter your brand color, such as `#3B82F6` for primary blue. Drag and drop your SVG or PNG logo (max 200x50px). Preview changes live, then click **Apply**.

For advanced customization, edit the config file:

```json { "theme": { "primaryColor": "#3B82F6", "logo": "/assets/logo.svg", "fontFamily": "Inter, sans-serif" } } ``` ```css :root { --pg-primary: #3B82F6; --pg-logo: url('/assets/logo.svg'); } ```

User Permissions and Access

Define roles to secure your documentation. Assign viewer, editor, or admin access at space or page level.

Role View Pages Edit Content Manage Users Delete Pages
Viewer ✅ ❌ ❌ ❌
Editor ✅ ✅ ❌ ❌
Admin ✅ ✅ ✅ ✅
Go to **Members > Invite**. Select role and expiration date. Edit page > **Permissions** > Add user/group with role. Integrate with Okta or Auth0 via OAuth. Configure in **Settings > Authentication**.

Exporting and Publishing Docs

Export your space as static HTML, PDF, or Markdown for hosting on Vercel, Netlify, or GitHub Pages.

Exports include all themes, images, and interactive components. Go to **Space > Export**. Choose format and include private pages if needed. Download ZIP or deploy directly to hosting provider.

Use the CLI for automation:

```bash npx paperguide export --type=html --output=dist/ ``` ```bash npx paperguide export --type=pdf --theme=dark ``` One-click deploy from export. Push dist/ folder to gh-pages branch.