Open the Article Editor #

Log in to the SigmaDocs Admin Dashboard.

From the left navigation menu, click: Content → Add New Article

The article editor will open, allowing you to create and publish documentation.

Article Information #

Title #

Enter the title of your documentation.

Examples:

  • Installation Guide
  • Authentication API
  • Getting Started
  • Deploy to cPanel
  • User Management

Choose a title that clearly describes the content.

Slug #

The slug creates the article URL.

Examples:

  • Installation Guide → installation-guide
  • Authentication API → authentication-api
  • Deploy to VPS → deploy-to-vps

Generated URL:

https://yourdomain.com/docs/installation-guide

Keep slugs:

  • Short
  • Lowercase
  • SEO-friendly
  • Hyphen separated

Excerpt #

The excerpt is a short summary of the article.

Example:

Learn how to install SigmaDocs on a cPanel hosting server using the built-in installer.

The excerpt may appear in search results, article listings, and previews.

Rich Text (HTML) Editor #

The Rich Text Editor is where you create your documentation.

Unlike traditional editors, SigmaDocs stores clean HTML while providing an easy visual editing experience.

You can create:

  • Documentation
  • Tutorials
  • API Guides
  • FAQ Pages
  • Product Manuals
  • Release Notes
  • Knowledge Base Articles

without manually writing HTML.

Editor Toolbar #

Undo & Redo #

Undo or restore recent changes while editing.

Bold #

Highlight important text.

Example: Important

Italic #

Use italics for notes or emphasis.

Example

Underline #

Underline important information.

Strike Through #

Display removed or deprecated content.

Deprecated

Inline Code #

Insert programming commands.

npm install

Perfect for:

  • Terminal commands
  • CSS
  • JavaScript
  • PHP
  • JSON
  • SQL

Paragraph Styles #

Change the current block into:

  • Paragraph
  • Heading 1
  • Heading 2
  • Heading 3
  • Heading 4
  • Quote
  • Code Block

Use headings to create structured documentation.

Example: Getting Started > Installation > Requirements, Configuration

Insert hyperlinks.

https://sigmatheme.com

Useful for:

  • External websites
  • Internal documentation
  • API references
  • Downloads

Embed Video #

Embed videos directly into documentation.

Supported platforms include:

  • YouTube
  • Vimeo
  • Other embeddable video providers

Perfect for installation tutorials and product demonstrations.

Image #

Upload and insert images into articles.

Recommended uses:

  • Screenshots
  • UI walkthroughs
  • Architecture diagrams
  • Feature previews
  • Workflow illustrations

Supported formats:

  • PNG
  • JPG
  • JPEG
  • WEBP

Video Upload #

Upload self-hosted video files.

Ideal for premium documentation where videos should remain on your own server.

Audio #

Attach audio clips such as:

  • Tutorials
  • Podcasts
  • Voice instructions

File Attachment #

Attach downloadable files.

Examples:

  • ZIP
  • PDF
  • Source Code
  • Documentation
  • Sample Projects

Visitors can download them directly from the article.

Tables #

Insert responsive tables.

Example:

  • Dark Mode — Available: ✓
  • Google Login — Available: ✓
  • SEO — Available: ✓

Ideal for:

  • API parameters
  • Feature comparisons
  • Pricing
  • Configuration options

Divider #

Insert horizontal separators to organize long articles into sections.

Publish Panel #

The Publish panel controls the visibility of the article.

Status #

Choose:

Draft #

Article remains unpublished.

Useful while writing.

Published #

Article becomes visible on the documentation website.

Preview #

Preview the article before publishing.

This allows you to verify formatting, images, tables, and layout.

Save Draft #

Save your work without making it publicly available.

Ideal for articles that require additional review.

Publish #

When the article is complete, click Publish.

The article will immediately become available to visitors.

Content Details #

Category #

Assign the article to a documentation category.

Examples:

  • Getting Started
  • Installation
  • API
  • Authentication
  • FAQ

Every article should belong to the most relevant category.

Tags #

Tags improve search and organization.

Examples:

  • installation
  • nextjs
  • express
  • api
  • deployment
  • authentication
  • seo

Use relevant keywords that describe the article.

SEO & Social #

SigmaDocs includes built-in SEO fields for better search engine visibility.

SEO Title #

Provide a search engine optimized title.

Example: How to Install SigmaDocs on cPanel | Complete Guide

Meta Description #

Write a concise summary between 150–160 characters.

Example: Learn how to deploy SigmaDocs on cPanel with Node.js, configure the installer, and publish your documentation in minutes.

Meta Keywords #

Enter keywords separated by commas.

Example: SigmaDocs, Next.js Documentation, Express CMS, Documentation Template, Knowledge Base

Canonical URL #

Specify the preferred URL when similar content exists.

https://yourdomain.com/docs/installation-guide

This helps prevent duplicate content issues.

Publishing Your Article #

After completing all required fields:

  • Enter the article title.
  • Create a URL slug.
  • Add an excerpt.
  • Write your documentation using the Rich Text Editor.
  • Select a category.
  • Add relevant tags.
  • Complete the SEO information.
  • Click Publish.

Your documentation is now live and searchable on your SigmaDocs website.