Flowfull Docs

Appearance

Flowfull Documentation ​

Official documentation for Flowfull - Build production-ready backends in record time with Pubflow.

🚀 Quick Start ​

Install Dependencies ​

bash
npm install
# or
yarn install
# or
pnpm install

Run Development Server ​

bash
npm run docs:dev
# or
yarn docs:dev
# or
pnpm docs:dev

The documentation will be available at http://localhost:5173

Build for Production ​

bash
npm run docs:build
# or
yarn docs:build
# or
pnpm docs:build

Preview Production Build ​

bash
npm run docs:preview
# or
yarn docs:preview
# or
pnpm docs:preview

📁 Documentation Structure ​

.
├── .vitepress/
│   └── config.mts          # VitePress configuration
├── core-concepts/          # Core concepts documentation
│   ├── index.md
│   ├── bridge-validation.md
│   ├── validation-modes.md
│   ├── hybridcache.md
│   ├── trust-tokens.md
│   ├── auth-middleware.md
│   ├── multi-database.md
│   └── environment.md
├── guides/                 # Feature-specific guides
│   ├── hybridcache.md
│   ├── trust-tokens.md
│   ├── protected-routes.md
│   ├── database-setup.md
│   └── deployment.md
├── languages/              # Language implementations
│   ├── nodejs.md
│   ├── go.md
│   ├── python.md
│   └── rust.md
├── api/                    # API reference
│   ├── bridge.md
│   ├── cache.md
│   └── middleware.md
├── index.md                # Home page
├── introduction.md         # Introduction
├── what-is-pubflow.md      # What is Pubflow?
├── getting-started.md      # Getting started guide
└── tutorial.md             # 30-minute tutorial

🎨 Customization ​

Theme Configuration ​

Edit .vitepress/config.mts to customize:

  • Navigation menu
  • Sidebar structure
  • Social links
  • Search configuration
  • Footer

Adding New Pages ​

  1. Create a new .md file in the appropriate directory
  2. Add frontmatter if needed:
md
---
title: Page Title
description: Page description
---

# Page Content
  1. Add the page to the sidebar in .vitepress/config.mts

📝 Writing Documentation ​

Markdown Features ​

VitePress supports:

  • ✅ Standard Markdown
  • ✅ GitHub Flavored Markdown
  • ✅ Frontmatter
  • ✅ Code blocks with syntax highlighting
  • ✅ Custom containers (tip, warning, danger, etc.)
  • ✅ Emoji 🎉
  • ✅ Table of contents
  • ✅ Custom components

Code Blocks ​

md
```typescript
// Your code here
const example = 'Hello World';
```

Custom Containers ​

md
::: tip
This is a tip
:::

::: warning
This is a warning
:::

::: danger
This is a danger message
:::
md
[Internal Link](/getting-started)
[External Link](https://pubflow.com)

🌐 Deployment ​

Deploy to Vercel ​

  1. Push to GitHub
  2. Import project in Vercel
  3. Set build command: npm run docs:build
  4. Set output directory: .vitepress/dist
  5. Deploy!

Deploy to Netlify ​

  1. Push to GitHub
  2. Import project in Netlify
  3. Set build command: npm run docs:build
  4. Set publish directory: .vitepress/dist
  5. Deploy!

Deploy to GitHub Pages ​

Add to .github/workflows/deploy.yml:

yaml
name: Deploy Docs

on:
  push:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: 18
      - run: npm install
      - run: npm run docs:build
      - uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: .vitepress/dist

📧 Support ​

📄 License ​

MIT License - Copyright © 2024 Pubflow