For: Brand new users
Goal: Teach basics, build confidence
Examples: Installation, first backup

For: Users solving specific problems
Goal: Step-by-step recipes assuming basic knowledge
Examples: Back up PostgreSQL, create Kloset store, automate backups

For: Looking up technical details
Goal: Describe commands, options, APIs
Examples: CLI commands, configuration files, flags

For: Understanding concepts
Goal: Provide context, discuss trade-offs
Examples: How Plakar works, backup strategies

For: Connecting Plakar to other services
Goal: Setup and configuration for integrations
Examples: S3, SFTP, tar, Notion, Google Drive, Proton Drive

1. Brand new to Plakar? → Getting Started
2. "How do I..."? → Guide
3. Command/option/API? → Reference
4. "Why does it work this way?" → Explanation
5. Service integration? → Integration

• Start Hugo server:

  hugo server --logLevel debug --disableFastRender --ignoreCache --noHTTPCache --templateMetrics

• React dev:

  • Go to: themes/plakarium/assets/react
  • Run: npm run watch

• Compile Tailwind CSS

  npx tailwindcss -c ./themes/plakarium/tailwind.config.js -i ./themes/plakarium/assets/css/main.css -o ./themes/plakarium/assets/css/main-compiled.css --watch

• Autoreload when layout changes

  • (requires to brew install fswatch on MacOS)
  • ./scripts/watch-layouts-changes.sh

• Change code highlight style

  • hugo gen chromastyles --style=monokailight > ./themes/plakarium/assets/css/chroma.css
  • hugo gen chromastyles --style=native > ./themes/plakarium/assets/css/native.css