Slate API Docs Generator

Slate API Docs Generator

تخته سنگ - اسناد استاتیک زیبا برای ویژگی های API.Feature
تخته سنگ - اسناد استاتیک زیبا برای API شما.ویژگی های طراحی تمیز و بصری - با استفاده از صفحه ، توضیحات API شما در سمت چپ مستندات شما قرار دارد و تمام نمونه های کد در سمت راست قرار دارند.با الهام از اسناد API Stripe و Paypal.صفحه نمایش پاسخگو است ، بنابراین در تبلت ها ، تلفن ها و حتی در چاپ بسیار عالی به نظر می رسد.همه چیز در یک صفحه واحد - رفته است روزهایی که کاربران شما مجبور بودند از طریق یک میلیون صفحه جستجو کنند تا آنچه را می خواستند پیدا کنند.اسلات کل اسناد را در یک صفحه قرار می دهد.ما پیوند را فدا نکرده ایم.وقتی حرکت می کنید ، هش مرورگر شما به نزدیکترین عنوان به روزرسانی می شود ، بنابراین پیوند دادن به یک نقطه خاص در مستندات هنوز طبیعی و آسان است.Slate فقط Markdown است - وقتی اسناد را با Slate می نویسید ، شما فقط Markdown را می نویسید ، این امر ویرایش و درک آن را ساده می کند.همه چیز در Markdown نوشته شده است - حتی نمونه کد ها فقط بلوک کد Markdown هستند.نمونه کد را به چند زبان بنویسید - اگر API شما به چندین زبان برنامه نویسی اتصال دارد ، می توانید به راحتی زبانه ها قرار دهید تا بین آنها جابجا شوید.در سند خود ، با مشخص کردن نام زبان در بالای هر بلوک کد ، درست مانند Github Flavored Markdown ، زبان های مختلف را تشخیص می دهید.نحو خارج از جعبه که تقریباً برای 60 زبان برجسته شده است ، به هیچ گونه تنظیمات لازم نیست.فهرست خودکار و صاف پیمایش شده از مطالب در سمت چپ صفحه.با حرکت ، موقعیت فعلی خود را در سند نمایش می دهید.خیلی سریع استما از Slate در TripIt برای ساخت اسناد برای API جدید خود استفاده می کنیم ، جایی که فهرست مطالب ما بیش از 180 مدخل دارد.ما اطمینان حاصل کرده ایم که عملکرد حتی در اسناد بزرگتر نیز عالی است.
slate-api-docs-generator

سایت اینترنتی:

دسته بندی ها

گزینه های دیگر برای Slate API Docs Generator برای Linux

Doxygen

Doxygen

Doxygen ابزاری برای تولید اسناد از منابع C ++ حاشیه نویسی و همچنین سایر زبانهای برنامه نویسی محبوب مانند C ، Objective-C ، C # ، PHP ، Java ، Python ، IDL (CORBA ...
swagger.io

swagger.io

Swagger یک ابزار مستند منبع باز RESTapi است.
DoxyS

DoxyS

DoxyS یک ابزار اسناد کد برای C ++ / C است.DoxyS تلاش می کند تا یک خروجی بسیار حرفه ای به دنبال داشته باشد و کد را در یک مجموعه آسان از صفحات HTML ارائه می دهد.
Javadoc

Javadoc

Javadoc ابزاری است از Sun Microsystems برای تولید اسناد API با فرمت HTML از نظرات توضیحات در کد منبع.
Natural Docs

Natural Docs

Natural Docs یک مولد مستندات منبع باز برای چندین زبان برنامه نویسی است.شما کد خود را به صورت نحوی طبیعی که مانند انگلیسی ساده خوانده می شود ، مستند می کنید.
CppDoc

CppDoc

CppDoc بر اساس کد منبع شما و نظرات ویژه تعبیه شده در داخل ، اسناد HTML را برای کلاسهای C ++ ایجاد می کند.
LuaDoc

LuaDoc

LuaDoc یک ابزار تولید اسناد برای ...
LDoc

LDoc

LDoc است ...
DapperDox

DapperDox

منبع باز و سرور اسناد API منبع باز برای مشخصات OpenAPI Swagger.