Open-source documentation workspace

Docs Foundry

A desktop documentation editor with live Markdown preview, sidebar file tree, and cross-platform installers. Built with Electron and a container-first development workflow.

Deploy GitHub Pages status Build Desktop Artifacts status Total views

Quick links

Download guide Roadmap Feedback All releases ↗ Build pipeline ↗ Source on GitHub ↗

Getting started

What is Docs Foundry?

Docs Foundry is an open-source desktop application for writing, editing, and previewing Markdown documentation. Think of it as a lightweight, local-first docs workspace built specifically for documentation projects rather than a general-purpose IDE.

Built for documentation rather than IDE sprawl: open a docs folder, write in Markdown, review the rendered result beside the editor, and package the same project for distribution without extra local setup.

01

Bring your own docs

Work directly from your repository or documentation folder with a local-first workspace instead of a hosted editing surface.

02

Write with immediate feedback

Draft in Markdown while the rendered preview stays beside the editor so structure, formatting, and content stay aligned.

03

Distribute like a product

Package the same workspace into native installers for macOS, Windows, and Linux without reworking the project around a separate toolchain.

Authoring Markdown editor

Distraction-free monospace editing with fast save, unsaved-change tracking, and a workspace built around docs instead of code noise.

Preview Live preview

See Markdown render in real time with headings, lists, code blocks, tables, and the formatting details that matter while writing.

Navigation Sidebar file tree

Open a docs folder and move through its structure quickly, keeping related Markdown, assets, and project files in one place.

Contributing Container-first development

No local Node.js required. Run make setup and contributors get the same Docker-based environment with project dependencies inside the container.

Distribution Cross-platform installers

Ship native DMG, NSIS, AppImage, and DEB outputs so people can install the app without building from source.

Maintenance Auto-update path

Packaged builds can check GitHub Releases for updates through electron-updater, which keeps distributed installs easier to maintain.

For end users

Download Docs Foundry

Grab the latest installer for your operating system. Builds are published automatically to GitHub Releases when a new version tag is pushed or when the release workflow is run manually with a tag name.

macOS

.dmg recommended  ·  .zip advanced

↓ Download for macOS

Gatekeeper: prefer the .dmg. If the ZIP build is blocked, run xattr -cr /path/to/DocFoundry.app once, then reopen it.

Windows

NSIS installer  ·  .zip

↓ Download for Windows

SmartScreen: if Windows warns, choose More info and then Run anyway.

Linux

AppImage  ·  .deb  ·  .tar.gz

↓ Download for Linux

For contributors

Quick start

Everything runs inside Docker. No local Node.js or npm required.

  1. Install Docker Get Docker Desktop or Docker Engine for your OS.
  2. Clone and setup git clone https://github.com/Cloud2BR/docs-foundry.git && cd docs-foundry && make setup
  3. Open a dev shell make container-shell. You're inside the container with all tools ready.
  4. Run quality checks make lint, make format, make test. All run inside the container.

Project identity

Owner / Organization

Docs Foundry v0.0.1 is presented as an open-source desktop release maintained by the owner and published through the Cloud2BR organization.

Organization

Cloud2BR organization icon Cloud2BR

Cloud2BR is the publishing organization behind the site, release assets, and open-source project distribution.

v0.0.1 release

Release context

  • Product: Electron desktop documentation workspace
  • Release channel: GitHub Releases with tagged binaries and installers
  • Presentation: GitHub Pages landing site for downloads and project overview
  • Scope: Initial public release for macOS, Windows, and Linux