Fuma studio

Getting Started

Introducing Fumastudio.

Quick Start

Get started with Fumastudio Docs:

Introduction

Fumastudio is a cost-effective, open alternative to Mintlify. Built primarily for Bruno http client. It enables both technical and non-technical teams to publish beautiful documentation sites without vendor lock-in. It integrates seamlessly with multiple HTTP clients and file formats, and will include features such as a no-code docs editor.

Getting started

Clone the following repository to get started. It has the fumastudio UI components in /components/fumastudio and a demo Bruno collection in /collections.

git clone https://github.com/emee-dev/nextjs-template

cd nextjs-template

Build the Bruno collection using the fumastudio cli

npx @trythis/fuma-content build ./collections --bruno --dist "./source"

Package manager

The identifier @trythis/fuma-content is only temporary and will be changed to something simpler.

Preview

After the collections has been built, go to http://localhost:3000/api-reference/freejsonapi/create-post to preview the documentation.

npm run dev

Supported frameworks

At the moment only the Nextjs fullstack framework is currently supported.

Deployment

To deploy your awesome docs. Follow the Deployment guidelines.