Title in ar

Description in ar

Author

Author in ar

مرحبا بكم في وثائق JSQuarto

حول

JSQuarto هي أداة مصممة لتوليد وثائق مرجعية لحزمة API جافا سكريبت باستخدام Markdown و Quarto. يعمل كبديل لـ JSDoc، ويوفر نهجا أبسط وأكثر مرونة لتوثيق شفرة جافا سكريبت.

الغرض

الغرض من JSQuarto هو تبسيط عملية إنشاء وثائق API المرجعية لحزم جافا سكريبت. من خلال الاستفادة من Markdown و Quarto، يمكن للمطورين إنشاء وحفظ وثائق شاملة لمشاريع جافا سكريبت الخاصة بهم.

إلهام

JSQuarto يستلهم من أدوات ومنهجيات التوثيق المختلفة، بما في ذلك:

JSDoc: JSDoc هو أداة شائعة لتوليد وثائق API من كود مصدر جافا سكريبت.
Quarto: Quarto هي أداة مؤلفة ونشر وثيقة متنوعة تدعم تنسيقات Markdown, LaTeX, and R Markdown.
Sphinx: Sphinx هو أداة لتوليد الوثائق تستخدم على نطاق واسع في مجتمع Python.

التعريب والترجمة

وشركة JSQuarto ملتزمة بدعم توطين وترجمة الوثائق التي تم إنشاؤها. نحن نخطط لدمج كراودن، وهي منصة لإدارة التعريب ، لتسهيل جهود الترجمة. وهذا سيمكن المستخدمين من تقديم ملفات QMD التي تم إنشاؤها بلغات متعددة، مما يجعل الوثائق متاحة لجمهور أوسع.

بدء العمل

Prerequisites

قبل اختبار الأداة محلياً، تأكد من وجود الشروط المسبقة التالية مثبتة على النظام الخاص بك:

Quarto
Babel Quarto
Node.js and npm (Node Package Manager)

Installation

لاختبار الأداة محلياً، قم باتباع الخطوات التالية:

Install the tool by running the command below
```
npm install -g @oscsa/jsquarto  
```

Usage

Once the dependencies are installed, you can navigate to the root directory of your project and follow the steps below:

لإنشاء الوثائق قم بتشغيل الأمر التالي
```
jsq doc:generate source=<path to source files> 
```
هذا سوف يستخرج تعليقات JSDoc من ملفات js و يكتبها إلى ملفات Quarto Markdown المقابلة.

If the source flag is not provided, the tool will set /source_files as default.

The generated .qmd files can be found in the /docs folder, you can change the output directory by providing the output flag.
لمعاينة الوثائق التي تم إنشاؤها قيد التشغيل
```
jsq doc:preview
```
سيؤدي هذا إلى إنشاء الوثائق، ومعاينة مع quarto وفتح رابط لمعاينة المستندات
The generated .qmd files can be found in the /docs folder, you can change the output directory by providing the output flag.
```
jsq doc:generate source=<path to source files> output=<path to output dir>
```

To include tutorials in the generated documentation, provide the tutorials flag.

jsq doc:generate source=<path to source files> tutorials=<path to tutorials directory>

For more information on how to integrate translation tools like Crowdin with JSquarto, refer to the Crowding workflow guide.

For more details on using JSquarto and to see an example of the generated documentation, visit the JSQuarto documentation

المنظمة المساهمة

تم تطوير وصيانة JSQuarto من قبل [المجتمع العلمي المفتوح في المملكة العربية السعودية] (https://github.com/Open-Science-Community-Saudi-Arabia). وتتمثل مهمتنا في تعزيز الممارسات العلمية المفتوحة وتعزيز التعاون بين الباحثين والمطورين في المملكة العربية السعودية.

الملاحظات والدعم

إذا كان لديك أي أسئلة، أو ردود فعل، أو تحتاج إلى دعم، يرجى [فتح مشكلة] (https://github.com/Open-Science-Community-Saudi-Arabia/JSquarto/issues) على GitHub أو الانضمام إلى مجتمعنا للحصول على المساعدة.