The Simple FAQ
A FAQ for ALL things FAQ Simple
Important Questions
What is FAQsimple?
One well-written FAQ can answer the same question for thousands of people. FAQsimple is a web application that enables you to build & publish FAQs for your customers, partners, and employees. In the era of AI, it provides critical context as a bridge between AI agents. With FAQsimple, ensure your FAQs are genuinely helpful:
* Critical working knowledge at everyone's fingertips
* Address the questions people are actually asking
* Keep content regularly updated and clearly written
* Translate your FAQ into other languages
* Share with the public or only select people
* Ensure support and AI systems handle inquiries accurately
What is an F.A.Q.?
An F.A.Q. is an acronym for Frequently Asked Questions. An FAQ is often one of the first support documents or web pages that customers and stakeholders can use to find answers to common questions about products, services, policies, or events without needing to contact support staff. They are commonly created and shared by product teams, customer support, human resources, marketing, event planning, and information technology or security teams.
Why is markdown used by AI?
In the realm of AI, particularly with large language models (LLMs) and chatbots, Markdown has become a widely adopted format for both input and output due to its inherent strengths. When you connect you FAQ to an AI system or agent (ex. via MCP), Markdown's simplicity, structure, and readability make it an ideal language for effective communication and interaction between humans and AI systems.
By embracing Markdown in your FAQ, you craft clearer prompts for AI and receive well-structured, readable responses, ultimately elevating their AI-powered workflows.
Here's why Markdown is favored by AI:
## Readability and Simplicity
Markdown’s straightforward syntax makes it easy for both humans and AI to read and understand content. Its minimalism allows LLMs to focus on the content itself rather than extraneous formatting information. This readability translates to reduced processing overhead for AI, as they don't need to navigate through complex tags like those found in HTML or XML.
## Structured and Semantic Input
AI models require structured and consistent data for training and generating accurate responses. Markdown's clear hierarchy, defined by elements like headings, lists, and tables, acts as signposts for LLMs, helping them understand the relationships between sections and the overall organization of the document.
## Improved Parsing and Interpretation
When content is presented in a structured format like Markdown, LLMs can parse and interpret the information more easily. For example, a Markdown heading clearly indicates a new section, while a bulleted list is easily recognized as a group of related items, helping the AI distinguish between different types of information and reducing ambiguity.
## Consistency and Reproducibility
Using Markdown ensures consistent formatting across documents, which is essential for LLMs in training and tasks requiring accuracy and reproducibility. Markdown's uniform syntax simplifies scripting and the automation of documentation and reports, ensuring a consistent format that is essential for automated workflows.
## Efficiency
Markdown's lightweight nature translates into efficiency for AI processing. It reduces the computational burden compared to formats like XML or JSON, which require more processing to extract content from tags and nested structures.
## Ease of Integration
Markdown documents can be easily integrated into various environments, from web pages to development tools and automation scripts, enhancing workflow versatility. Many AI data pipelines and knowledge base builders convert sources into Markdown before feeding them to models.
## Flexibility and Adaptability
Markdown can be easily converted to other formats, like HTML or PDF, making it a flexible choice for content that needs to be repurposed across different platforms or used in diverse AI applications.
## LLM readiness
Markdown is essential for text generation and large language models (LLMs) in training and inference because it can provide structured, semantic, human, and machine-readable input. Likewise, Markdown facilitates chunking and structuring input data for better retrieval and synthesis in the context of RAGs, and its simplicity and ease of parsing and rendering make it ideal for AI Agents.
What markdown formatting is supported in answers?
Full markdown support includes:
- Headers (H1-H6)
- Bold, italic, and underline text
- Horizontal Lines
- Emojis (ex. :smile: :heart: :thumbsup: :warning: :check: :star:)
- Bullet and numbered lists
- Links
- Code snippets (Code blocks with syntax highlighting)
- Blockquotes
- Alerts (NOTE, TIP, IMPORTANT, WARNING, CAUTION)
> [!TIP]
> Only H1 and H2 headers are listed in the FAQ table of contents.
Other Questions
What are the different user roles in FAQsimple?
There are three main user roles: Owner, Contributor, Read-Only
- **Owner**: Full access to all features, including configuration, publishing, and user management
- **Contributor**: Can create and edit questions (as drafts), but cannot publish or modify FAQ settings
- **Read-Only**: Can view FAQ content but cannot make any modifications
Why isn't my FAQ logo displaying?
Please verify the following:
- File format is JPEG or PNG
- File size is under 10MB
- Upload completed successfully
- Clear browser cache if needed
> [!TIP]
> Logos look best if they are 50 pixels in height.
How often is FAQsimple updated?
Frequently Asked Questions can be updated at any time. Any changes or new questions and answers will be made available immediately upon publication.
In addition, the FAQsimple platform receives regular updates, including:
- Bug fixes and performance improvements
- New features based on user feedback
- Security updates and compliance enhancements
What are the FAQsimple software requirements?
Supported browser versions are those we test all our releases against, and we will work to resolve any issues that occur on them.
# Desktop Browsers
On desktop, we support Chromium-based browsers (e.g. Chrome, Edge, Opera), Firefox, and Safari.
_Supported versions_
* Chromium (e.g. Chrome and Edge) - Version 140 and newer.
* Firefox - Version 142 and newer.
* Safari - Version 18 and newer.
# Mobile Browser
On mobile, we support Chrome and Safari.
_Supported versions_
* Chrome - Version 140 and newer.
* Safari - Version 18 and newer.
How can FAQsimple answers be formatted with markdown?
# FAQ Answer Markdown Syntax Guide
This document describes the markdown syntax supported in FAQ answers. All formatting follows GitHub's markdown specification and includes advanced features like alerts and task lists.
## 1. Headings
Use `#` symbols to create headings. More `#` symbols create smaller headings.
### Syntax:
```markdown
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
```
### Example:
```markdown
# Main Topic
## Subtopic
### Details
```
## 2. Styling Text
### Bold
Use `**` or `__` to make text bold.
#### Syntax:
```markdown
**This is bold text**
__This is also bold text__
```
### Italic
Use `*` or `_` to make text italic.
#### Syntax:
```markdown
*This is italic text*
_This is also italic text_
```
### Strikethrough
Use `~~` to strike through text.
#### Syntax:
```markdown
~~This text is crossed out~~
```
### Bold and Nested Italic
Combine bold and italic formatting.
#### Syntax:
```markdown
**This text is _extremely_ important**
***All this text is important***
```
### Subscript and Superscript
Use HTML tags for subscript and superscript.
#### Syntax:
```markdown
H2O
X2
```
### Underline
Use HTML tags for underlined text.
#### Syntax:
```markdown
This text is underlined
```
## 3. Quoting Text
Use `>` to create blockquotes.
### Syntax:
```markdown
> This is a blockquote
>
> It can span multiple paragraphs
```
### Example:
```markdown
> "The best way to predict the future is to create it." - Peter Drucker
```
## 4. Quoting Code
### Inline Code
Use single backticks for inline code within sentences.
#### Syntax:
```markdown
Use the `console.log()` function to output text.
The `npm install` command downloads dependencies.
Press `Ctrl+C` to stop the server.
```
#### Examples:
```markdown
To run the application, use the `npm start` command.
The variable `userName` stores the current user's name.
Call the `getData()` function to retrieve information.
```
### Code Blocks
Use triple backticks for code blocks, optionally with language specification.
#### Syntax:
````markdown
```javascript
function greet(name) {
console.log(`Hello, ${name}!`);
}
```
````
## 5. Supported Color Models
You can reference colors in text using HEX, RGB, or HSL values.
### Syntax:
```markdown
The color is `#0969da` in HEX format.
You can also use `rgb(9, 105, 218)` or `hsl(212, 92%, 45%)`.
```
## 6. Links
Create clickable links using square brackets and parentheses.
### Syntax:
```markdown
[Link text](https://example.com)
[Link with title](https://example.com "This is a tooltip")
```
### Example:
```markdown
Visit [FAQsimple](https://faqsimple.com) to create your own FAQ.
```
## 7. Line Breaks
End a line with two spaces to create a line break, or leave a blank line for a paragraph break.
### Syntax:
```markdown
This is the first line
This is the second line
This is a new paragraph.
```
## 8. Images
Use similar syntax to links, but with an exclamation mark at the beginning.
### Syntax:
```markdown
```
### Example:
```markdown
```
## 9. Lists
### Unordered Lists
Use `-`, `*`, or `+` for bullet points.
#### Syntax:
```markdown
- First item
- Second item
- Third item
```
### Ordered Lists
Use numbers with periods.
#### Syntax:
```markdown
1. First item
2. Second item
3. Third item
```
## 10. Nested Lists
Indent items to create nested lists.
### Syntax:
```markdown
1. First item
- Nested item
- Another nested item
2. Second item
1. Nested numbered item
2. Another nested numbered item
```
## 11. Task Lists
Create interactive checkboxes using `- [ ]` for unchecked and `- [x]` for checked.
### Syntax:
```markdown
- [x] Completed task
- [ ] Incomplete task
- [x] Another completed task
```
### Example:
```markdown
## Project Setup
- [x] Install dependencies
- [x] Configure database
- [ ] Deploy to production
- [ ] Update documentation
```
## 12. Emojis
Use `:emoji_name:` syntax to insert emojis.
### Syntax:
```markdown
:smile: :heart: :thumbsup: :warning: :check: :star:
```
### Supported Emojis:
- `:smile:` → 😊
- `:heart:` → ❤️
- `:thumbsup:` → 👍
- `:thumbsdown:` → 👎
- `:warning:` → ⚠️
- `:info:` → ℹ️
- `:question:` → ❓
- `:exclamation:` → ❗
- `:check:` → ✅
- `:x:` → ❌
- `:star:` → ⭐
- `:fire:` → 🔥
- `:rocket:` → 🚀
- `:lightbulb:` → 💡
- `:gear:` → ⚙️
- `:key:` → 🔑
## 13. Paragraphs
Separate paragraphs with blank lines for proper spacing and readability.
### Example:
```markdown
This is the first paragraph with some important information.
This is the second paragraph that covers different topics.
This is the third paragraph with additional details.
```
## 14. Footnotes
Create footnotes using `[^1]` syntax for references and definitions.
### Syntax:
```markdown
Here's a sentence with a footnote[^1].
[^1]: This is the footnote content.
```
### Example:
```markdown
FAQsimple is a powerful platform[^platform] for creating knowledge bases.
[^platform]: FAQsimple supports multilingual content and AI-powered search.
```
## 15. Alerts
Create GitHub-style alerts using special blockquote syntax.
### Note Alert
```markdown
> [!NOTE]
> Useful information that users should know, even when skimming content.
```
### Tip Alert
```markdown
> [!TIP]
> Helpful advice for doing things better or more easily.
```
### Important Alert
```markdown
> [!IMPORTANT]
> Key information users need to know to achieve their goal.
```
### Warning Alert
```markdown
> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.
```
### Caution Alert
```markdown
> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.
```
### Alert Examples:
```markdown
> [!NOTE]
> This feature is available in all subscription plans.
> [!TIP]
> Use keyboard shortcuts Cmd+S (Mac) or Ctrl+S (Windows) to save quickly.
> [!IMPORTANT]
> Make sure to backup your data before proceeding with this operation.
> [!WARNING]
> This action cannot be undone. Please proceed with caution.
> [!CAUTION]
> Deleting this FAQ will permanently remove all associated questions and answers.
```
## 16. Horizontal Rules
Create horizontal lines to visually separate content sections.
### Syntax:
Use three or more asterisks (`***`), dashes (`---`), or underscores (`___`) on a line by themselves.
```markdown
***
---
___
```
### Examples:
```markdown
This is content above the line.
---
This is content below the line.
***
Another section here.
___
Final section.
```
All three methods create the same visual result - a horizontal line that spans the width of the content area.
## 17. Escaping Markdown Characters
Use backslashes (`\`) to display literal markdown characters without formatting.
### Syntax:
```markdown
\*This text will not be italic\*
\**This text will not be bold\**
\# This will not be a heading
\[This will not be a link\]
\`This will not be code\`
```
### Examples:
```markdown
Let's rename \*our-new-project\* to \*our-old-project\*.
Use \*\*asterisks\*\* to show the actual markdown syntax.
The \# symbol creates headings when not escaped.
To display \`code syntax\` literally, escape the backticks.
Escape \[square brackets\] and \(parentheses\) for literal display.
```
### Common Escaped Characters:
- `\*` - Literal asterisk (prevents bold/italic)
- `\_` - Literal underscore (prevents bold/italic)
- `\#` - Literal hash (prevents heading)
- `\`` - Literal backtick (prevents code)
- `\[` `\]` - Literal brackets (prevents links)
- `\(` `\)` - Literal parentheses (prevents links)
- `\-` - Literal dash (prevents lists)
- `\>` - Literal greater than (prevents blockquotes)
## Complete Example
Here's a comprehensive example using multiple markdown features:
```markdown
# Getting Started with FAQsimple
Welcome to **FAQsimple**! This guide will help you create your first FAQ.
## Prerequisites
Before you begin, make sure you have:
- [x] A FAQsimple account
- [x] Basic understanding of markdown
- [ ] Content ready for your FAQ
> [!TIP]
> Start with a simple FAQ and expand it over time.
## Step-by-Step Instructions
1. **Create a new FAQ**
- Go to your dashboard
- Click the "New FAQ" button
2. **Add your content**
- Write questions in plain text
- Use markdown for rich formatting in answers
3. **Customize appearance**
- Upload your logo
- Set brand colors
- Add a banner image
### Code Example
Here's how to embed code in your answers:
```javascript
function createFAQ(title) {
return {
title: title,
questions: [],
isPublic: false
};
}
```
### Showing Markdown Syntax
To demonstrate markdown syntax, use escaping:
- Use \*single asterisks\* for \*italic\* formatting
- Use \*\*double asterisks\*\* for \*\*bold\* formatting
- Use \# for headings like \# Main Title
- Use \`backticks\` for \`inline code\` display
---
*This guide was last updated on Sept. 22, 2025* :star:
