Skip to main content

​
Getting Started

​
Prerequisites

  • A verified account on RTFM.guide
  • Something valuable to share with the community

​
Access the Editor

  1. Click Create Guide from:

​
Writing Your Guide

​
Title

Choose a clear, descriptive title that tells readers exactly what they’ll learn:

Good Titles

  • “How to Set Up Tailwind CSS v4 in Laravel”
  • “Deploy Next.js to Vercel in 5 Minutes”
  • “Fix ‘Module Not Found’ in Vite Projects”

Bad Titles

  • “Tailwind”
  • “My Deployment Guide”
  • “Help Please”

​
Content

Write your content in GitHub-flavored Markdown. The editor provides a live preview so you can see exactly how your guide will look.

​
Markdown Basics

# Main Heading
## Sub Heading

**Bold text** and *italic text*

- Bullet point
- Another point

1. Numbered list
2. Second item

[Link text](https://example.com)

![Image alt text](image-url.jpg)

​
Code Blocks

Use triple backticks with language specification: 
```javascript
function hello() {
  console.log("Hello, world!");
}
```
Supported languages include:
  • JavaScript/TypeScript
  • Python
  • PHP
  • Ruby
  • Go
  • Rust
  • SQL
  • Bash
  • And many more

​
Tables

| Feature | Support |
|---------|---------|
| Markdown | ✅ |
| Code blocks | ✅ |
| Images | ✅ |
Pro tip: Use the preview pane to see your formatting in real-time!

​
Guide Settings

​
Visibility

Choose who can see your guide:
  • Public: Visible to everyone, appears in searches
  • Unlisted: Only accessible via direct link
  • Private: Only you can see it (coming soon)

​
Status

  • Draft: Save your work and come back later
  • Published: Make it live and searchable
Drafts are only visible to you. You can have unlimited drafts and publish them whenever ready.

​
Categories & Tags (Coming Soon)

  • Select relevant categories
  • Add specific technology tags
  • Help users discover your guide

​
Publishing Your Guide

1

Write Content

Create your guide using Markdown
2

Preview

Review how your guide will look
3

Set Visibility

Choose Public, Unlisted, or Private
4

Publish

Click Publish to make it live

​
After Publishing

​
View Your Guide

  • Click the View button to see your published guide
  • Share the URL with others
  • It will appear in the guides listing

​
Edit Your Guide

You can edit published guides anytime:
  1. Go to My Guides
  2. Find your guide
  3. Click Edit
  4. Make changes and republish

​
Track Performance

Monitor your guide’s impact:
  • View count
  • Reaction count
  • Comments
  • Saves (coming soon)

​
Best Practices

  • Assume basic knowledge
  • Explain complex concepts
  • Use examples and code snippets
  • Test your code before publishing
  • Use headings for organization
  • Break up long paragraphs
  • Include step-by-step instructions
  • Add visual aids when helpful
  • Specify versions in your title
  • Update when libraries change
  • Add a “last updated” note
  • Respond to comments about issues
  • Provide complete code examples
  • Include installation commands
  • Show expected output
  • Explain common errors

​
Guidelines

Please review our Community Guidelines before publishing:
  • Be respectful: No hate speech or harassment
  • Be accurate: Test your code and verify information
  • Be original: Don’t plagiarize others’ work
  • Be helpful: Write with the intent to help others

​
Need Help?

  • Review the Markdown Guide
  • Check out popular guides for inspiration
  • Ask in the comments of this guide