Website logo
⌘
K
Book a DemoSign Up ->
🌐
User & Dev Guide
💼
Careers
💻
Demo
GitHub Example
🚀GETTING STARTED
👋Welcome to Archbee 🤓
Learn the basics
How to get started
📝EDITOR
📃DOCUMENTS
🗃️SPACES
🌎HOSTED SPACES
🔃PUBLIC API
GET
Get document
POST
Update / Create document
DELETE
Delete document
GET
Search document
☕ORGANIZATIONS
📦IMPORT & EXPORT
🔌INTEGRATIONS
📥GUIDES
➿MISC
🙋Q&A
Docs powered by Archbee
EDITOR

Editor Markdown Shortcuts

Archbee's editor supports Markdown syntax.

  • Link Markdown -> [label](www.go.com) + space bar
  • Divider Markdown -> --- + space bar
  • Heading 1 -> # + space bar
  • Heading 2 -> ## + space bar
  • Heading 3 -> ### + space bar
  • Checklist -> [] + space bar
  • Quote -> >
  • Inline Code Markdown -> `text`
  • Bold Markdown -> **text**
  • Underline Markdown -> __text__
  • Italic Markdown -> *text*
  • Italic Markdown -> _text_
  • Strike Markdown -> ~~text~~
  • Numbered List -> 1. + space bar
  • Bulleted List -> - + space bar
  • Bulleted List -> * + space bar
  • Add code snippet -> ```

On top of the standard Markdown syntax, there are shortcuts you can use to render Archbee's custom blocks.

Tabs block

Tab 1
Tab Photos

Some content for Tab 1

Pull requests are very welcome! Please see CONTRIBUTING.md for more information. Tthis is really nice

This is a checkbox list

This is a checkbox list

This is done

This is a checkbox list

Document image


We would love you to contributeaaa

Use the following Markdown to generate a Tabs block.

Markdown
## Tabs

:::::tabs
::::tab{title="Tab 1"}
Some content for Tab 1

:::hint{style="info"}
Pull requests are very welcome! Please see CONTRIBUTING.md for more information.
Tthis is really nice
:::

- [x] This is a checkbox list
- [x] This is a checkbox list
- [ ] This is done
- [ ] This is a checkbox list
::::

:::tab{title="Tab Photos"}
![](https://placehold.co/600x400)

We would love you to contributeaaa
:::
:::::


There is an alternative flavour of Markdown that you can use to generate a Tabs block.

Markdown
{% tabs %}
{% tab title="tab 2" %}some tab fasdfasdfasdfasdfads {% endtab %}
{% tab title="tab 2" %}some tab fasdfasdfasdfasdfads {% endtab %}
{% tab title="tab 2" %}some tab fasdfasdfasdfasdfads {% endtab %}
{% tab title="tab 2" %}some tab fasdfasdfasdfasdfads
{% endtab %}
{% endtabs %}



Callouts

We would love you to contribute to @octokit/rest, pull requests are very welcome! Please see CONTRIBUTING.md for more information.

We would love you to contribute to @octokit/rest, pull requests are very welcome! Please see CONTRIBUTING.md for more information.

We would love you to contribute to @octokit/rest, pull requests are very welcome! Please see CONTRIBUTING.md for more information.

We would love you to contribute to @octokit/rest, pull requests are very welcome! Please see CONTRIBUTING.md for more information.

Use the following Markdown to generate a Callout block.

Markdown
## Hints

:::hint
We would love you to contribute to `@octokit/rest`, pull requests are very welcome! Please see CONTRIBUTING.md for more information.
:::

:::hint{style="info"}
We would love you to contribute to `@octokit/rest`, pull requests are very welcome! Please see CONTRIBUTING.md for more information.
:::

:::hint{style="warning"}
We would love you to contribute to @octokit/rest, pull requests are very welcome! Please see CONTRIBUTING.md for more information.
:::

:::hint{style="success"}
We would love you to contribute to @octokit/rest, pull requests are very welcome! Please see CONTRIBUTING.md for more information.
:::


There is an alternative flavour of Markdown that you can use to generate a Callout block.

Markdown
{% hint style="info" %}
some hint
{% endhint %}




Link Blocks

Link block header image
  • list item 1
  • list item 2

unchecked list box

checked list box

Use the following Markdown to generate a Links block.

Markdown
## Link Array

::::link-array
:::link-array-item{headerType="IMAGE" headerImage="https://placehold.co/600x400"}

- list item 1
- list item 2
:::
:::link-array-item{headerType="COLOR" headerColor="#ff00FF"}

- [ ] unchecked list box
- [x] checked list box
:::
::::



Code block with a single tab

Node.js
var http = require('http');

http.createServer(function (req, res) {
  res.writeHead(200, {'Content-Type': 'text/plain'});
  res.end('Hello World!');
}).listen(8080);


Use the following Markdown to generate a Code block with a single code example

Markdown
## Code block

```nodejs
var http = require('http');

http.createServer(function (req, res) {
  res.writeHead(200, {'Content-Type': 'text/plain'});
  res.end('Hello World!');
}).listen(8080);
```



Code blocks without language

Text
Text
Text
// code block not specified


Use the following Markdown to generate a Code block without specifying the language.

Markdown
## Code blocks

:::::codeblocktabs

```
// code block not specified
```

```
// code block not specified
```

```
// code block not specified
```

:::::



Code editor with multiple tabs

PHP
Java
Go
JS
// PHP is the best.


Use the following Markdown to generate a Code block with multiple tabs.

Code drawers

Test Code Drawer

/
a code drawer
PHP
Go
JSON
// Some wordpress plugi
 // Add our plugin's option page to the WP admin menu.
  public function add_plugin_options_page() {
    add_options_page(
      'Example Plugin Settings',
      'Example Plugin Settings',
      'manage_options',
      'ex',
      [$this, 'render_admin_page']
    );
  }
// 404 -  not found
{
  requireFingerprintScope: true,
  maxMachines: 1,
  concurrent: false,
  floating: false,
  protected: true,
  strict: true
}


Use the following Markdown to generate Code Drawer blocks.

Markdown
### Test codedrawer

::::codedrawer{title="a code drawer"}
:::codeblocktabs-examples
```php
// Some wordpress plugi
 // Add our plugin's option page to the WP admin menu.
  public function add_plugin_options_page() {
    add_options_page(
      'Example Plugin Settings',
      'Example Plugin Settings',
      'manage_options',
      'ex',
      [$this, 'render_admin_page']
    );
  }
```
```go
// Next should be used only inside middleware.
// It executes the pending handlers in the chain inside the calling handler.
// See example in GitHub.
func (c *Context) Next() {
    c.index++
    for c.index < int8(len(c.handlers)) {
        c.handlers[c.index](c)
        c.index++
    }
}
```
```javascript
// demo js
```
:::
:::codeblocktabs-responses
```json
// 404 -  not found
{
  requireFingerprintScope: true,
  maxMachines: 1,
  concurrent: false,
  floating: false,
  protected: true,
  strict: true
}
```
:::
::::


Changelogs

Test Changelog

v1.2 Release
Added
Deep tabular data is now supported
Improved
Works 0.000001% faster
Fixed
Team mates not receiving emails fast enough


Use the following Markdown to generate Changelogs blocks

Markdown
### Test Changelog

:::changelog{title="v1.2 Release"}
::changelog-item{type="added" description="Deep tabular data is now supported"}
::changelog-item{type="improved" description="Works 0.000001% faster"}
::changelog-item{type="fixed" description="Team mates not receiving emails fast enough"}
:::




Updated 22 Nov 2023
Did this page help you?
PREVIOUS
@ Mentions and Dynamic Links
NEXT
Workflow block
Docs powered by Archbee
TABLE OF CONTENTS
Tabs block
Callouts
Link Blocks
Code block with a single tab
Code blocks without language
Code editor with multiple tabs
Code drawers
Test Code Drawer
Changelogs
Test Changelog
Docs powered by Archbee