Mkdocs 1 Documentation Structure

Sub-skill of mkdocs: 1. Documentation Structure (+1).

vamseeachanta 041ee3a 1.2 KB Updated

File contents

1. Documentation Structure (+1)

1. Documentation Structure

docs/
├── index.md                    # Landing page
├── getting-started/
│   ├── index.md               # Section overview
│   ├── installation.md
│   ├── quickstart.md
│   └── configuration.md
├── user-guide/
│   ├── index.md
│   ├── concepts.md
│   ├── tutorials/
│   │   ├── basic.md
│   │   └── advanced.md
│   └── best-practices.md
├── api/
│   ├── index.md
│   └── reference.md
├── contributing/
│   ├── index.md
│   ├── development.md
│   └── style-guide.md
├── changelog.md
├── assets/
│   ├── images/
│   ├── stylesheets/
│   └── javascripts/
└── includes/                   # Reusable snippets
    └── abbreviations.md

2. Page Template

---
title: Page Title
description: Brief description for SEO and social sharing
---

# Page Title

Brief introduction explaining what this page covers.

vamseeachanta/workspace-hub/tree/main/.agents/skills/_internal/documentation/mkdocs/1-documentation-structure commit 041ee3a7fb

Frequently asked questions

npx skillmds@latest add vamseeachanta/mkdocs-1-documentation-structure