Files
ALwrity/docs-site/mkdocs.yml
ajaysi b2b5769ad9 feat: Add comprehensive documentation structure
- Created ALwrity introduction page with vision summary
- Added detailed installation guide with step-by-step instructions
- Created comprehensive configuration guide for API keys and settings
- Added first steps guide with complete user onboarding flow
- Updated navigation structure to include all new pages
- Preserved existing documentation while organizing it logically
- Optimized for SEO with proper structure and metadata
2025-09-24 18:09:58 +05:30

112 lines
2.7 KiB
YAML

site_name: ALwrity Documentation
site_description: AI-Powered Digital Marketing Platform - Complete Documentation
site_url: https://alwrity.github.io/ALwrity
repo_url: https://github.com/AJaySi/ALwrity
repo_name: AJaySi/ALwrity
edit_uri: edit/main/docs-site/docs/
# Copyright
copyright: Copyright © 2024 ALwrity Team
# Configuration
theme:
name: material
palette:
# Light mode
- scheme: default
primary: blue
accent: light blue
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Dark mode
- scheme: slate
primary: blue
accent: light blue
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.tabs
- navigation.sections
- navigation.expand
- navigation.path
- navigation.top
- search.highlight
- search.share
- search.suggest
- content.code.copy
- content.code.annotate
- content.action.edit
- content.action.view
font:
text: Roboto
code: Roboto Mono
icon:
repo: fontawesome/brands/github
edit: material/pencil
view: material/eye
# Plugins
plugins:
- search:
lang: en
# Markdown extensions
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
combine_header_slug: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- admonition
- pymdownx.details
- pymdownx.superfences
- attr_list
- md_in_html
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- tables
- toc:
permalink: true
title: On this page
# Extra configuration
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/AJaySi/ALwrity
# Navigation structure
nav:
- Home: index.md
- About: about.md
- Getting Started:
- Quick Start: getting-started/quick-start.md
- Installation: getting-started/installation.md
- Configuration: getting-started/configuration.md
- First Steps: getting-started/first-steps.md
- Features:
- Blog Writer:
- Overview: features/blog-writer/overview.md
- SEO Dashboard:
- Overview: features/seo-dashboard/overview.md
- Guides:
- Troubleshooting: guides/troubleshooting.md