Get Started
๐ Welcome to Archbee!
We're stoked to have you here :)
What are we going to cover
Archbee
Learn how to get started with Archbee
Showcase
Discover how teams around the world use Archbee.
Documentation 101
Learn how to start a documentation site.
Now let's explore the editor
๐ธ Get rolling with the editor
Highlight any text, and use the menu to style *your *writing however you like;
Click anywhere and start typing;
Go to a new row and type / to add blocks; add anything from lists, tables to diagrams and API docs (OpenAPI or GraphQL) or embed 30+ other software like Figma, Loom, Airtable;
Use Markdown shortcuts to format,* like ## or *** ;
Go to a new row and type @ to link documents or mention people in your organization
To the left are your collections, an easy way to hierarchically organize your docs
Spaces can be branded & shared on your own domain, and it looks like docs.storj.io, docs.onarchipelago.com or our own docs docs.archbee.com
๐ Endpoint docs
Below is a single endpoint descriptor. Great for describing webhooks or single endpoint APIs.
Get Cakes
This endpoint allows you to get free cakes.
Code examples
curl --request GET
--url https://api.cakes.com/v1/cakes/:id
--header 'Accept: application/json'Responses
{
"name": "Cake's name",
"recipe": "Cake's recipe name",
"cake": "Binary cake"
}โจ๏ธ Code blocks
package main
import "fmt"
import "time"
func worker(done chan bool) {
fmt.Print("working...")
time.Sleep(time.Second)
fmt.Println("done")
done <- true
}
๐ API Docs
You can add OpenAPI apis by typing (swagger). You can also add GraphiQL allowing you to play with your GraphQL endpoints. Just type (gql) in the editor.
๐ Changelogs
Need good looking changelogs?
๐ฃ Callouts
Need to draw attention quickly?
๐ด Danger
By philosophy, the library won't warn you when you modify your past, so you might delete your entire existence.
๐ฎ And of course, because it's the 2023s
Everything in this workspace is realtime!
****๐ก Diagrams
Below is a Mermaid.js diagram, markdown based.
sequenceDiagram
participant Alice
participant Bob
Alice->>John: Hello John, how are you?
loop Healthcheck
John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts <br/>prevail!
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!๐งโโ๏ธ We're great listeners, talk to us
๐ Have a question? Click the ? at the bottom right for guides or to send us a message.
int_0^infty x^2 dx