Getting Started#
Excited to get your documentation site up and running? You're in the right place! This guide will walk you through creating your first project and publishing your first page.
Creating Your First Project#
Sign Up for Dokly
Head over to dokly.co and create your account. Don't worry – you can start with our free plan and upgrade anytime.
Create a New Project
Once you're logged in, click "New Project" and give it a name. This will be part of your subdomain, so choose something memorable!
Choose Your Subdomain
Your project will be available at yourprojectname.dokly.co. Pick something that represents your project well.
Writing Your First Page#
Now for the fun part – creating content! Dokly's editor makes this super easy.
Using the Editor#
Our WYSIWYG editor supports rich formatting right out of the box. Here's what you can do:
- Rich text formatting – Bold, italic, links, and more
- Code blocks with syntax highlighting
- Special components like callouts, tabs, and steps
- Drag and drop to reorder pages
Try typing / in the editor to see all available components and formatting options. It's like a magic wand for documentation!
Adding Pages#
To add a new page:
- Click "Add Page" in your project dashboard
- Give it a title and start writing
- Use the page hierarchy to organize your content
- Hit "Save" when you're done
Publishing Your Site#
Once you're happy with your content:
Review Your Pages
Make sure all your pages look good and are organized the way you want.
Publish Your Project
Click the "Publish" button in your project settings. Your site will be live at your chosen subdomain!
Share with the World
Send the link to your team, customers, or anyone who needs to access your documentation.
Your site updates in real-time as you make changes. No need to republish unless you want to unpublish temporarily.