qalam

Generate Arabic documentation from Python, JavaScript, and TypeScript codebases.

29|5|Updated Mar 26, 2026
One-click install
npx skills add https://github.com/Moshe-ship/mkhlab --skill qalam
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: qalam
Source: https://github.com/Moshe-ship/mkhlab/tree/main/skills/qalam
Command: npx skills add https://github.com/Moshe-ship/mkhlab --skill qalam

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

أداة لتوليد توثيق عربي تلقائي من كود البرمجي، مما يوفر الوقت والجهد في كتابة التوثيق يدويًا وتقليل الأخطاء.

Core Features & Use Cases

  • توليد توثيق تقني تلقائي من ملفات Python/JS/TS مع قاموس تقني مدمج (300+ مصطلح).
  • دعم العمل بدون إنترنت لإنتاج وثائق جاهزة للـ README/Docs وتسهيل المشاركة.
  • مثال عملي: عند وجود مشروع Python يحتوي على دوال وكلاسات، يقوم Qalam باستخراج الواجهات والدوال وتوليد توثيق بالعربية.

Quick Start

شغّل qalam generate src/ لتوليد التوثيق العربي من مشروعك.

Frequently Asked Questions about qalam

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate Arabic documentation for a Python project?

You can automatically generate Arabic documentation for a Python project by parsing the codebase to extract APIs and building a technical glossary. This process produces structured output formats like Markdown, Docstrings, or HTML with right-to-left support.

Can I generate offline Arabic README files from JavaScript and TypeScript codebases?

Yes, you can generate offline Arabic README files from JavaScript and TypeScript codebases. The tool parses source files, extracts interfaces and functions, and builds structured technical docs locally without requiring an internet connection.

What is the best way to create technical code documentation in Arabic without writing it manually?

The best way to create technical code documentation in Arabic is to use an automated generation tool that extracts APIs and utilizes a built-in technical glossary of over 300 terms. This reduces manual effort and minimizes errors in your docs.

Does the Arabic code documentation generator support right-to-left HTML output?

Yes, the Arabic code documentation generator supports right-to-left HTML output. It provides multiple format options including Markdown, Docstring, README, and HTML, ensuring proper rendering for Arabic technical content.

Can I use this tool to document individual modules and packages in an offline environment?

Yes, you can document individual files, modules, and packages in an offline environment. The tool runs locally to extract APIs and generate structured Arabic documentation without needing network access.