Getting Started with ALGONETIC
Set up your ALGONETIC account and create your first documentation space in just a few minutes.
Prerequisites
Ensure you have:
- A modern web browser (Chrome, Firefox, or Safari)
- An email address for account verification
- Optional: A GitHub account for version control integration
ALGONETIC makes it easy to set up your documentation workspace. Follow these steps to get started in under five minutes.
Sign Up and Log In
Create your account and access the dashboard.
Visit the Dashboard
Navigate to https://app.algonetic.com.
Sign Up
Click Sign Up and enter your email, password, and workspace name.
Verify your email via the confirmation link sent to your inbox.
Log In
Return to the dashboard and sign in with your credentials.
You'll land on the main interface.
Create Your First Documentation Space
Set up a new project for your docs.
New Space
Click New Space in the sidebar.
Configure Space
Enter a name like My Project Docs, select a template (e.g., "API Docs"), and choose your brand color #3B82F6.
Publish Preview
Save and preview your space at a custom URL like myproject.app.algonetic.com.
Basic Interface Navigation
Explore key areas using these tabs.
Overview of your spaces, recent edits, and analytics.
Use the search bar to find documents quickly.
Markdown/MDX editor with live preview.
Supports components like <Callout> and code syntax highlighting.
Manage multiple documentation projects.
Organize with folders and tags.
Upload Initial Documents
Add content to your space.
Upload Files
Drag and drop .mdx or .md files into your space root.
Create New Doc
Click New Document and start with a template.
Example MDX Snippet
Use this basic structure:
---
title: My First Page
---
## Introduction
Welcome to your docs!
<Callout kind="tip">
Pro tip: Use components for rich content.
</Callout>
> **Tip:** Use blockquotes for simple callouts.
Simple Organization Tips
Organize your documentation hierarchically:
- Use folders for major sections:
/guides/,/api/,/faq/ - Prefix files consistently:
01-quickstart.mdx,02-auth.mdx - Add frontmatter to every page for SEO and navigation
| Structure | Purpose | Example |
|---|---|---|
| Root pages | Entry points | introduction.mdx, quickstart.mdx |
| Subfolders | Deep dives | api/reference.mdx |
_sidebar.mdx | Navigation | Custom menu items |
Ready for more? Check your first space and experiment with editing.
Next Steps
Last updated today