منصوبے کے بارے میں

Material for MkDocs ایک ڈاکومنٹیشن فریم ورک ہے جو MkDocs، جو کہ ایک اسٹیٹک سائٹ جنریٹر ہے، پر بنایا گیا ہے۔ اس پروجیکٹ کا بیان کردہ مقصد یہ ہے کہ مصنفین Markdown میں ڈاکومنٹیشن لکھیں اور کسی اوپن سورس یا تجارتی پروجیکٹ کے لیے مختصر وقت میں ایک پیشہ ورانہ، قابلِ تلاش اسٹیٹک سائٹ حاصل کریں، جس کے لیے HTML، CSS یا JavaScript کے ساتھ براہ راست کام کرنے کی ضرورت نہ ہو۔ README میں بیان کردہ بنیادی خصوصیات: Markdown-first authoring: مواد Markdown میں لکھا جاتا ہے، اور فریم ورک رینڈرنگ اور سائٹ جنریشن کو سنبھالتا ہے۔ شائع شدہ ڈاکومنٹیشن سائٹ تیار کرنے کے لیے فرنٹ اینڈ کے کسی سابقہ علم کی ضرورت نہیں ہے۔ Responsive output: تیار کردہ سائٹ دستیاب اسکرین سائز کے مطابق ڈھل جاتی ہے، جس میں ڈیسک ٹاپ، ٹیبلٹ اور موبائل ویو شامل ہیں۔ Customization: رنگ، فونٹس، زبان، آئیکنز اور لوگو کو کنفیگریشن کے ذریعے تبدیل کیا جا سکتا ہے، اور فریم ورک ظاہری شکل اور رویے کو تبدیل کرنے کے لیے آپشنز فراہم کرتا ہے، جسے آسانی سے قابلِ توسیع (extendable) قرار دیا گیا ہے۔ Performance and footprint: اس تھیم کو تیز اور ہلکا پھلکا پیش کیا گیا ہے، جس کا مقصد سرچ انجن کی اچھی رینکنگ اور صارفین کی واپسی ہے۔ Ownership and control: چونکہ ڈاکومنٹیشن کے ذرائع اور آؤٹ پٹ صارف کے ہاتھ میں رہتے ہیں، اس لیے یہ پروجیکٹ تھرڈ پارٹی پلیٹ فارمز پر پروڈکٹ نالج ہوسٹ کرنے کے مقابلے میں سالمیت اور سیکیورٹی کے فوائد کو اجاگر کرتا ہے۔ Internationalization: README میں 60 سے زائد زبانوں کی حمایت کا ذکر ہے۔ انسٹالیشن اور کنفیگریشن جان بوجھ کر کم رکھی گئی ہے۔ پیکیج کو PyPI سے `pip install mkdocs-material` کے ذریعے انسٹال کیا جاتا ہے، اور تھیم کو mkdocs.yml میں دو لائنیں شامل کر کے فعال کیا جاتا ہے: theme: name: material ایک Docker امیج بھی Docker Hub پر squidfunk/mkdocs-material نیم اسپیس کے تحت شائع کی گئی ہے۔ تفصیلی سیٹ اپ ہدایات، کنفیگریشن آپشنز اور ایک لائیو ڈیمو پروجیکٹ کی ڈاکومنٹیشن سائٹ squidfunk.github.io/mkdocs-material پر فراہم کیے گئے ہیں۔ README میں نوٹ کیا گیا ہے کہ یہ پروجیکٹ اوپن سورس ٹیکنالوجیز کے ساتھ بنایا گیا ہے اور MIT لائسنس کے تحت ہے، جس کا کاپی رائٹ 2016-2025 Martin Donath کے پاس ہے۔ Adoption: README میں تنظیموں اور پروجیکٹس کا ایک وسیع مجموعہ درج ہے جو اپنی ڈاکومنٹیشن کے لیے اس تھیم کا استعمال کرتے ہیں، جن میں ArXiv, Atlassian, AWS, Bloomberg, CERN, Datadog, Google, Harvard, Hewlett Packard, HSBC, ING, Intel, JetBrains, LinkedIn, Microsoft, Mozilla, Netflix, OpenAI, Red Hat, Salesforce, Siemens, Slack, Square, Uber اور Zalando جیسے صنعتی نام شامل ہیں، ساتھ ہی Apache Iceberg, Arduino, Asahi Linux, AutoKeras, CentOS, Crystal, eBPF, ejabberd, Electron, FastAPI, FlatBuffers, {fmt}, Freqtrade, GoReleaser, GraphRAG, Headscale, HedgeDoc, Hummingbot, Knative, kSQL, LeakCanary, LlamaIndex, NetBox, Nokogiri, OpenFaaS, OpenSSL, Orchard Core, Percona, Pi-Hole, Polars, Pydantic, PyPI, Quivr, Renovate, RetroPie, Ruff, Traefik, Trivy, Typer, tinygrad, Ultralytics, UV, Vapor, WebKit, WTF اور ZeroNet جیسے اوپن سورس پروجیکٹس بھی شامل ہیں۔ README میں سلور اور برونز اسپانسرز کے ایک مجموعے کا بھی اعتراف کیا گیا ہے جن کے لوگوز صفحے پر موجود ہیں۔ مختصر یہ کہ، Material for MkDocs ان ٹیموں اور مینٹینرز کو ٹارگٹ کرتا ہے جو سادہ Markdown فائلوں سے تیار کردہ ایک خود مختار، قابلِ ترتیب اسٹیٹک ڈاکومنٹیشن سائٹ چاہتے ہیں، جس کا انسٹالیشن راستہ صرف ایک پیکیج انسٹال اور ایک مختصر کنفیگریشن سنپٹ پر مشتمل ہے۔