Getting Started
Get Started
15 min
๐ 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 ๐ธ 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 https //www archbee io/integrations 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 https //docs onarchipelago com/ or our own docs docs archbee com https //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'fetch("https //api cakes com/v1/cakes/\ id", { "method" "get", "headers" { "accept" "application/json" } }) then(response => { console log(response); }) catch(err => { console error(err); });const fetch = require('node fetch'); let url = 'https //api cakes com/v1/cakes/\ id'; let options = { method 'get', headers { accept 'application/json', } }; fetch(url, options) then(res => res json()) then(json => console log(json)) catch(err => console error('error ' + err));import requests url = "https //api cakes com/v1/cakes/\ id" headers = {"accept" "application/json"} response = requests request("get", url, headers=headers) print(response text) responses { "name" "cake's name", "recipe" "cake's recipe name", "cake" "binary cake" }{ "message" "ain't no cake like that " } โจ๏ธ 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 } \# python3 program to demonstrate \# the use of sample() function \# import random import random \# prints list of random items of \# length 3 from the given list list1 = \[1, 2, 3, 4, 5, 6] print("with list ", random sample(list1, 3)) \# prints list of random items of \# length 4 from the given string string = "geeksforgeeks" print("with string ", random sample(string, 4)) \# prints list of random items of \# length 4 from the given tuple tuple1 = ("ankit", "geeks", "computer", "science", "portal", "scientist", "btech") print("with tuple ", random sample(tuple1, 4)) \# prints list of random items of \# length 3 from the given set set1 = {"a", "b", "c", "d", "e"} print("with set ", random sample(set1, 3)) / c# program to check whether the entered year is a leap year or not / using system; using system collections generic; using system linq; using system text; namespace program { class leapyear { static void main(string\[] args) { leapyear obj = new leapyear(); obj readdata(); obj leap(); } int y; public void readdata() { console writeline("enter the year in four digits "); y = convert toint32(console readline()); } public void leap() { if ((y % 4 == 0 && y % 100 != 0) || (y % 400 == 0)) { console writeline("{0} is a leap year", y); } else { console writeline("{0} is not a leap year", y); } console readline(); } } } ๐ 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 https //mermaid js github io/mermaid/#/ 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