Home / Documentation

Friday Documentation

Welcome to the complete documentation for Friday, the Obsidian plugin that transforms your notes into beautiful websites.

Getting Started

Installation

  1. Open Obsidian's Community Plugins
  2. Search for Friday and install
  3. Enable the plugin
  4. The Friday panel will appear in your sidebar

Quick Start

  1. Choose a theme from the MDFriday panel
  2. Download the theme's sample notes
  3. Right-click a note β†’ Publish to Web
  4. Click Preview to see it live locally

Once previewed, edit the sample notes with your own content β€” and you've got your personal site!

How Friday Works

Friday follows a simple 4-step process:

  1. Write - Create your content in Obsidian using markdown
  2. Choose - Select from 500+ professional themes
  3. Preview - See instant local preview as you edit (WYSIWYG)
  4. Publish - Deploy with one click or export static files

Key Features

πŸ“ Flexible Publishing

  • Individual notes - Publish single pages instantly
  • Entire folders - Publish complete site structures
  • Selective publishing - Choose exactly what to share
  • Batch operations - Handle multiple files at once

πŸš€ Lightning Fast Local Preview

  • Instant building - No waiting, no uploads needed
  • Real-time updates - See changes immediately as you edit
  • WYSIWYG experience - What you see is what you get
  • Local processing - Everything happens on your machine

🎨 500+ Beautiful Themes

Choose from professionally designed themes for every purpose:

☁️ Multiple Deployment Options

  • Netlify - One-click deployment to Netlify
  • FTP Upload - Custom hosting via FTP
  • Local Export - Export complete static site files
  • GitHub Pages - Deploy via GitHub integration (coming soon)

Step-by-Step Workflow

1. Install and Setup

1. Install Friday from Community Plugins
2. Open the Friday panel in your sidebar
3. Browse available themes
4. Download sample content for your chosen theme

2. Customize Content

1. Edit the downloaded sample notes with your content
2. Add your own images, text, and structure
3. Use Obsidian's markdown features normally
4. Organize files in folders as needed

3. Preview Locally

1. Right-click any note β†’ "Publish to Web"
2. Click "Preview" button
3. Friday builds your site instantly
4. Browser opens showing your live site
5. Edit files and see changes in real-time

4. Deploy Online

Option A - Netlify:
1. Click "Deploy to Netlify"
2. Authorize with your Netlify account
3. Your site is live instantly

Option B - Export Files:
1. Click "Export Site"
2. Choose destination folder
3. Upload files to any web host

Option C - FTP Upload:
1. Configure FTP settings
2. Click "Upload via FTP"
3. Files sync to your server

Theme Categories

Documentation Sites

Perfect for project docs, API references, user guides:

  • Clean, professional layouts
  • Navigation sidebars
  • Search functionality
  • Code syntax highlighting

Blog & Personal Sites

Great for personal blogs, portfolios, journals:

  • Article layouts with dates
  • Tag and category support
  • Social media integration
  • Comment systems

Business & Landing Pages

Ideal for companies, products, services:

  • Hero sections and CTAs
  • Feature showcases
  • Contact forms
  • SEO optimization

Portfolio & Resume Sites

Showcase your work and experience:

  • Project galleries
  • Timeline layouts
  • Skill representations
  • Download links for PDFs

Advanced Features

Frontmatter Support

Friday recognizes standard frontmatter fields:

---
title: "My Page Title"
date: 2023-10-15
tags: [web, design]
featured_image: "hero.jpg"
description: "Page description for SEO"
---

Multi-language Sites

Create internationalized websites:

content/
β”œβ”€β”€ en/
β”‚   β”œβ”€β”€ about.md
β”‚   └── blog/
└── zh/
    β”œβ”€β”€ about.md
    └── blog/

Custom Styling

Override theme styles with:

  • Custom CSS files
  • Theme configuration files
  • Sass/SCSS support (theme dependent)

Deployment Options Explained

Netlify Deployment

  • Pros: Free hosting, automatic SSL, form handling
  • Best for: Personal sites, small projects
  • Setup: One-click authorization

FTP Upload

  • Pros: Use your existing hosting, full control
  • Best for: Business sites, custom domains
  • Setup: Configure FTP credentials once

Local Export

  • Pros: Maximum flexibility, any hosting provider
  • Best for: Advanced users, custom setups
  • Setup: Choose export location, upload manually

Troubleshooting

Common Issues

Preview not working?

  • Check if port 8090 is available
  • Restart Obsidian if needed
  • Verify theme files are complete

Images not showing?

  • Use relative paths from note location
  • Place images in same folder or subfolder
  • Check image file extensions are supported

Theme not loading?

  • Ensure theme files are in correct location
  • Check theme compatibility with Friday version
  • Try downloading theme again

Deployment failing?

  • Verify internet connection
  • Check deployment service credentials
  • Review error messages in console

Getting Help

Developer Information

Friday is built with:

  • TypeScript - Full type safety
  • Hugo Engine - World's fastest static site generator (rewritten)
  • React - Modern UI components
  • Obsidian API - Deep integration with Obsidian

Contributing

We welcome contributions! See our GitHub repository for:

  • Source code
  • Issue tracking
  • Feature requests
  • Development setup

License

Friday is free and open source, released under the MIT License. See the LICENSE file for details.

Need more help?