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