Headless Documenation for software teams

DocWeaver collects your team's documentation from separate repositories into one place, keeping it alongside your code so you can focus on content, not presentation.

DocumentationGitHub

Brought to you by Angus

# 1

What is DocWeaver?

DocWeaver is a tool that allows you to pull in documentation from your repositories and display them in a beautiful and easy-to-navigate website. It's like a documentation site generator, but instead of having to write markdown files by hand, you just write them in your repository and DocWeaver takes care of the rest.

A single DocWeaver server can be configured to pull in documentation from multiple repositories, allowing you to create a single source of truth for all your documentation.

Core features

  • Automatic parsing: DocWeaver automatically parses your markdown files and generates a beautiful documentation site
  • Modular: Configuration happens in a single place, making it easy to manage and maintain your documentation site
  • No dependencies: Keep your existing services clean and free of any dependencies
  • Consistent: Keep your documentation in sync with your codebase and make it easier to keep it up-to-date

# 2

Simple Documentation

Write documentation without the hassle of maintaining another tool—DocWeaver automatically detects your markdown files and generates a polished documentation site.

Unlike other tools, DocWeaver removes the complexity of managing a documentation site, letting you focus purely on content.

Simply write in markdown, and DocWeaver transforms it into a beautiful, easy-to-navigate website.

# 3

Clutter free codebase

DocWeaver is focused on convention over configuration. This means as long as your docs folder is in the root of your repositories, DocWeaver will automatically pick it up and parse the markdown files inside.

This keeps your codebase clean and free of any dependencies and allows you to focus on writing documentation instead of configuring DocWeaver.

# 4

Modular design

Your can configure your DocWeaver server to pick up certain repositories and ignore others. This allows you tailor build your documentation site to only include the repositories you want to share with your team or the public.

Configuration will be done in a single place as supposed to having to configure each repository individually. This makes it easier to manage and maintain your documentation site.