Writing Pages

The Cirth editor combines the simplicity of markdown with the power of a rich text editor. This guide covers everything you need to write great documentation.

The Editor Interface

The page editor consists of:

1. Toolbar - Formatting buttons for common actions

2. Content Area - Where you write your documentation

3. Sidebar - Page settings and metadata

Text Formatting

Basic Formatting

Headings

Use headings to structure your content:

      

        markdown
        
          
          
        
      
    # Heading 1 (Page Title)
## Heading 2 (Major Sections)
### Heading 3 (Subsections)
#### Heading 4 (Minor Sections)

Tip: Start with H2 for sections since H1 is used for the page title.

Code Blocks

Code blocks are essential for technical documentation.

Creating Code Blocks

Use triple backticks with a language identifier:

      

        markdown
        
          
          
        
      
    ```javascript
function greet(name) {
  return `Hello, ${name}!`;
}
```

Supported Languages

Cirth supports syntax highlighting for 100+ languages including:

• JavaScript, TypeScript, JSX, TSX

• Python, Ruby, Go, Rust

• HTML, CSS, SCSS, Tailwind

• JSON, YAML, TOML, XML

• Bash, Shell, PowerShell

• SQL, GraphQL

• And many more!

Code Block Features

• Copy button - One-click copy for readers

• Line numbers - Automatic numbering

• Language label - Shows the language name

Lists

Unordered Lists

      

        markdown
        
          
          
        
      
    - First item
- Second item
  - Nested item
  - Another nested item
- Third item

Ordered Lists

      

        markdown
        
          
          
        
      
    1. First step
2. Second step
3. Third step

Task Lists

      

        markdown
        
          
          
        
      
    - [x] Completed task
- [ ] Pending task
- [ ] Another task

Links and Images

External Links

      

        markdown
        
          
          
        
      
    [Link Text](https://example.com)

Internal Links

Link to other pages in your documentation:

      

        markdown
        
          
          
        
      
    [See the Quick Start Guide](/docs/your-project/quick-start)

Images

      

        markdown
        
          
          
        
      
    ![Alt text](https://example.com/image.png)

Blockquotes

Use blockquotes for important callouts:

      

        markdown
        
          
          
        
      
    > **Note**: This is an important note that readers should pay attention to.

Renders as:

Note: This is an important note that readers should pay attention to.

Tables

Create tables with markdown syntax:

      

        markdown
        
          
          
        
      
    | Column 1 | Column 2 | Column 3 |
|----------|----------|----------|
| Cell 1   | Cell 2   | Cell 3   |
| Cell 4   | Cell 5   | Cell 6   |

Page Settings

Title and Slug

• Title: The main heading shown at the top of the page

• Slug: URL-friendly identifier (auto-generated, but editable)

Description

Write a brief description for:

• SEO meta description

• Social sharing previews

• Search result snippets

Page Status

• Draft: Only visible to you in the editor

• Published: Visible to all viewers (if project is public)

Page Order

Control the sequence of pages in navigation:

• Lower numbers appear first

• Use increments of 10 for easy reordering (10, 20, 30...)

Parent Page

Create hierarchical documentation by selecting a parent:

• Leave empty for top-level pages

• Select a page to nest underneath it

Page History

Cirth automatically saves your page history:

1. Click History in the toolbar

2. View previous versions with timestamps

3. Preview any version

4. Click Restore to revert changes

History uses smart compression to store changes efficiently.

Keyboard Shortcuts

Speed up your writing with shortcuts:

Writing Tips

1. Lead with value - Start pages with the most important information

2. Use examples - Show, don't just tell

3. Be concise - Respect your readers' time

4. Test code - Verify all code examples work

5. Update regularly - Keep documentation in sync with your product