Markdown content direct included in the page

Stable

HEADS UP!!!
LINKS TO OTHER SITE DOCS MUST BE GIVEN USING THE PERMALINKS, NOT THE FILE NAME

Link to file in different folder

broken link

good external link

broken external link

HEADS UP!!!!
- Liquid tags may generate unexpected behaviour sometimes due to dry rendering during site build.
- Dry rendering is used in the site build process to generate related pages and keywords
- It may be possible to have the front matter rendered also

using site vars from siteConfig: xxx

Markdown content generated from one part of another site page

📚 Introduction

Welcome to the Documentation Site Builder Guide — your comprehensive resource for learning how to create, build, and maintain high-quality documentation sites for any kind of project, product, or organization.

Whether you’re a solo developer, technical writer, open-source contributor, startup team, or enterprise content strategist, this guide will walk you through everything you need to know about building a complete, maintainable, and professional documentation site from scratch.

🚀 What Is This Guide?

This guide is a step-by-step manual that explains:

How to plan, structure, and organize documentation
How to choose the right tools and technologies
How to build a fully functional documentation site
How to style and customize your site for branding
How to publish and maintain your site efficiently

📌 Who Is This For?

This guide is suitable for:

Developers who want to document APIs, libraries, or frameworks
Product teams building internal or customer-facing documentation
Technical writers looking to improve structure and clarity
Open-source maintainers aiming to create onboarding guides
Educators and trainers documenting tutorials or curricula
Anyone who wants to build a knowledge base or help center

No prior experience with documentation systems is required — we start from the basics and build up.

🧱 What Will You Learn?

By the end of this guide, you will understand:

1. Documentation Strategy

Identifying your audience
Structuring documentation types: tutorials, references, FAQs, etc.

2. Tooling & Frameworks

Markdown best practices
Choosing deployment platforms (e.g., GitHub Pages, Netlify)

3. Site Architecture

Folder structures and content organization
Sidebar and navigation
Search and indexing setup

4. Content Writing & Style

Clear writing principles
Terminology consistency
Code block formatting and annotations
Accessibility considerations

5. Theming & Customization

Branding your docs
Adding custom styles
Creating reusable components

6. Publishing & Maintenance

Continuous deployment
Changelogs
Community contributions
Keeping docs up to date

🛠️ Prerequisites

To follow along with this guide, you’ll need:

Basic familiarity with Git and GitHub
A working knowledge of Markdown
A development environment
Access to a browser and a text editor (e.g., VS Code)

📁 What’s in This Documentation?

This site is divided into logical sections, each building on the previous one:

Getting Started – Overview, goals, and tooling setup
Planning Your Docs – Audience analysis, content hierarchy, and types
Building the Site – Installing, configuring, and running your documentation framework
Writing Great Docs – Tips, formatting, structure, and consistency
Customization – Layout, themes, branding, and interactive elements
Deployment – Hosting, CI/CD pipelines, versioning, and analytics
Best Practices – Accessibility, localization, SEO, and maintenance workflows
Examples & Templates – Starter projects, reusable snippets, and content scaffolds

🧭 Why Docs Matters

Well-written documentation is more than just a user manual:

It helps users understand and use your product
It reduces support burden and onboarding time
It builds trust, credibility, and community
It enables contribution and collaboration
It preserves institutional knowledge

Good documentation isn’t just nice to have — it’s a core part of product success.

✅ Let’s Get Started

Use the sidebar to navigate to the first section and begin your journey. Each topic includes examples, templates, and real-world tips to help you go from blank page to beautiful docs.

Markdown content generated from a file from a collection. This file has its own content but loads external content too.

General

This is a file from a collection

External content

This file loads some external content from another repo and place it inline.

Link to file in different folder

Markdown content generated from one part a partial which is not a site page

partial 1

h2 from partial md file

I am a paragraph from a partial file under a h2 title. The h2 title will be placed in ToC under the first h1 found in the document above this h2 title.

h1 from partial file

I am a paragraph from a partial file under a h1 title. The h1 title will be placed on the 1st level of Toc.