Back to Help Centre

Untitled

Unknown Author

Help Centre Content Management

This directory contains all help articles for the ExtractGrid Help Centre. Each article is stored as a Markdown file with frontmatter metadata.

File Structure

content/help/
├── README.md (this file)
├── getting-started-guide.md
├── new-features-update.md
├── troubleshooting-guide.md
└── [your-new-article].md

Adding New Help Articles

1. Create a New Markdown File

Create a new .md file in this directory with a descriptive filename (use kebab-case).

Example: advanced-templates-guide.md

2. Add Frontmatter

Every help article must start with frontmatter containing:

---
title: "Your Article Title"
postedBy: "Author Name"
date: "YYYY-MM-DD"
---

Required Fields:

  • title: The article title (displayed on the help page)
  • postedBy: The author's name
  • date: Publication date in YYYY-MM-DD format

3. Write Your Content

After the frontmatter, write your article content using Markdown syntax.

Supported Markdown Features:

  • Headers (# ## ###)
  • Bold (text) and italic (text)
  • Lists (ordered and unordered)
  • Links text
  • Code blocks and inline code
  • Blockquotes
  • Horizontal rules (---)

Example:

---
title: "Advanced Template Configuration"
postedBy: "John Doe"
date: "2024-01-30"
---

# Advanced Template Configuration

This guide covers advanced template features...

## Creating Custom Templates

### Step 1: Basic Setup
1. Navigate to the template editor
2. Upload a sample document
3. Define extraction areas

### Step 2: Advanced Options
- Use **bold text** for emphasis
- Add `code snippets` for technical details
- Include [links](https://example.com) to resources

> **Note:** This is a blockquote for important information.

---
*Last updated: January 30, 2024*

4. Automatic Updates

Once you save the file, the help page will automatically:

  • Display the new article in the list with title, summary, and metadata
  • Sort it by date (newest first)
  • Create a dedicated page at /help/[slug] for the full content
  • Generate static pages for better performance and SEO

Content Guidelines

Writing Style

  • Use clear, concise language
  • Write for a general audience
  • Include practical examples
  • Use step-by-step instructions when appropriate

Structure

  • Start with an introduction
  • Use headers to organize content
  • Include a summary or conclusion
  • Add relevant links and resources

Images and Media

  • Currently, only text content is supported
  • Use descriptive text to explain concepts
  • Consider adding screenshots in future updates

File Naming Conventions

  • Use kebab-case: my-article-title.md
  • Be descriptive but concise
  • Avoid special characters except hyphens
  • Use lowercase letters

URL Structure

  • Main Help Page: /help - Shows list of all articles
  • Individual Articles: /help/[slug] - Full article content
  • Slug Generation: Automatically generated from filename (e.g., getting-started-guide.md → /help/getting-started-guide)

Best Practices

  1. Regular Updates: Keep articles current and accurate
  2. Consistent Formatting: Follow the established markdown patterns
  3. Clear Titles: Make titles descriptive and searchable
  4. Proper Dates: Use actual publication dates
  5. Author Attribution: Credit the actual author

Troubleshooting

Article Not Appearing

  • Check that the file has .md extension
  • Verify frontmatter is properly formatted
  • Ensure the date is in YYYY-MM-DD format
  • Check for syntax errors in markdown

Formatting Issues

  • Validate markdown syntax
  • Check for proper header hierarchy
  • Ensure lists are properly formatted
  • Verify link syntax

Support

For questions about content management or technical issues:

  • Check the main help articles
  • Contact the development team
  • Review markdown documentation

Last updated: January 2024