The built-in visual editor provides a seamless, what-you-see-is-what-you-get (WYSIWYG) experience for creating and managing your documentation. Whether you are drafting a quick tutorial or structuring a complex API reference, the editor helps you focus on your content without worrying about raw Markdown syntax.
While you work in a visual environment, GitDocAI automatically generates clean, standard Markdown and configuration files under the hood. You get the ease of a visual tool with the portability of plain text.
Core Concepts
The visual editor is designed around a block-based layout system. Everything you add to a page—from a simple paragraph to a complex interactive component—is treated as a distinct block that can be styled, moved, or configured independently.
Content and Layout
Building a page is as simple as stacking and arranging blocks. You don't need to memorize formatting rules; the editor provides intuitive menus and toolbars for all your layout needs.
- 1
Select a block type
Click the + button on any empty line in the editor to open the block menu.
- 2
Add your content
Choose from standard elements like headings, text, and images, or select advanced components like callouts and code blocks.
- 3
Format and arrange
Highlight text to use the inline formatting toolbar, or use the drag handle on the left side of any block to reorder your layout.
Styling and Global Settings
Consistency is key to great documentation. The visual editor separates page-level content from site-wide styling, ensuring your brand looks cohesive across every guide and reference.
| Feature | Description | Best For |
|---|---|---|
| Rich Text | Inline formatting like bold, italics, and code. | Emphasizing key terms in paragraphs. |
| Block Settings | Alignment, background colors, and spacing for specific blocks. | Highlighting a specific section on a page. |
| Global Styles | Site-wide theme settings including primary colors and typography. | Maintaining brand consistency across all documentation. |
Set up your Global Styles first. When you add new blocks later, they will automatically inherit your brand's colors and fonts, saving you time on manual formatting.
The Publishing Workflow
Creating content is an iterative process. The visual editor supports a clear lifecycle from your first draft to the final published page.
flowchart LR
A[Draft Content] --> B[Preview Layout]
B --> C{Looks Good?}
C -->|No| A
C -->|Yes| D[Save Changes]
D --> E[Publish to Live Site]When you save your work, it is securely stored as a draft. Your readers won't see your changes until you explicitly click Publish, allowing you to review your formatting and layout in a safe environment.
Frequently Asked Questions
Can I still write in raw Markdown?
Yes! The visual editor supports Markdown shortcuts. If you type # and press space, it will automatically convert to a Heading 1. You can also paste existing Markdown directly into the editor, and it will be parsed into visual blocks automatically.
How do I add interactive components?
Type / in the editor to bring up the quick-insert menu. From there, you can search for and insert interactive components like Tabs, Accordions, and Steps.
Next Steps
Ready to dive deeper? Explore these detailed guides to master the visual editor: