Skip to Content
Getting StartedQuick Start

Quick Start

This guide walks you through the core workflow in under five minutes. By the end you will have a workspace, a wiki page, and a stored project key.

Create a workspace

Click the + button next to the workspace name in the sidebar. Enter a name like my-project and press Enter. localWiki auto-generates an icon and color from the workspace name.

Create a page

With your workspace selected, click the + button next to the “pages” heading in the sidebar. Type a page title and press Enter. A blank page opens in the editor.

Write some content

Start typing. The editor supports Markdown shortcuts:

# Project Overview This is the internal wiki for **my-project**. ## Architecture We use a microservices setup with three main services: - `api-gateway` — routes incoming requests - `auth-service` — handles JWT authentication - `data-service` — manages PostgreSQL connections

Your content is automatically saved as you type. No save button needed.

Add a project key

Open the Project Keys tab in the sidebar. Click Add Key and enter:

  • Name: DATABASE_URL
  • Value: postgresql://user:pass@localhost:5432/mydb

The key is encrypted and tied to your workspace. You can copy it to your clipboard anytime.

Done

You now have a workspace with documentation and a securely stored credential. Everything lives on your local machine — no data left your device.

Getting started with localWiki is fast because there are no accounts, no cloud setup, and no team invitations. Just open the app, set a master password, and start writing.

Next steps

Last updated on