الوثائقالصفحات والتخطيطات في الملفات

Markdown و MDX

هناك تنسيقان لصفحات المحتوى: .md عندما تحتاج فقط إلى Markdown، .mdx عندما تحتاج إلى مكونات.

.md: طاهر Markdown

الملف .md هو محتوى خالص. يعرضه Nexy على أنه بنكهة GitHub Markdown (الجداول، وقوائم المهام، ويتوسطه خط، والروابط)، ويضيف معرفات العناوين، ويشتق جدول محتويات، ويغلفه في أقرب layout.*.

src/routes/about.md
# About Nexy is a fullstack Python meta-framework.
  • لا يتم استخدام Frontmatter في .md كمنطق Python. إذا كنت بحاجة إلى منطق الخادم، فاستخدم .nexy.
  • يتم عرض HTML الخام في صفحة .md كنص، ولا يتم تشغيله مطلقًا. إذا كنت بحاجة إلى HTML، استخدم .nexy.
  • يعمل التفاف التخطيط وصفحات الخطأ والشرائح الديناميكية بنفس الطريقة التي تعمل بها الصفحات الأخرى.

.mdx: Markdown بالمكونات

.mdx يتم تجميع الملفات بواسطة Vite، من خلال مسار مسار الإطار (React أو Preact). Python يكتب فقط الغلاف الرقيق الذي يخدم المسار؛ لا يقوم أبدًا بتجميع أو عرض MDX بنفسه. يتم عرض المكونات بواسطة إطار العمل، ويتم عرضها بواسطة الخادم مثل مسارات المكونات الأخرى، ويتم عرضها مسبقًا إلى HTML بواسطة nx build.

  • يتطلب useFF أن يكون React أو Preact.
  • يتطلب الحزم الاختيارية @mdx-js/rollup و remark-gfm و @mdx-js/react (و @mdx-js/esbuild للإنشاء). Vite يخبرك أيهما مفقود.
  • يتم اكتشاف إطار العمل تلقائيًا من الواردات: Preact عندما يستورد الملف preact، React بخلاف ذلك.

الخطوات التالية

حرِّر على GitHub

Enter يفتح النتيجة، وEsc يغلق.