slatedocs/slate: Beautiful static documentation for your API

Slate is just Markdown — When you write docs with Slate, you're just writing Markdown, which makes it simple to edit and understand. Everything is written in ... Skiptocontent {{message}} slatedocs / slate Publictemplate Notifications Star 33.4k Fork 21k BeautifulstaticdocumentationforyourAPI slatedocs.github.io/slate Apache-2.0License 33.4k stars 21k forks Star Notifications Code Issues 32 Pullrequests 1 Discussions Actions Wiki Security Insights More Code Issues Pullrequests Discussions Actions Wiki Security Insights main Branches Tags Couldnotloadbranches Nothingtoshow Loading {{refName}} default Couldnotloadtags Nothingtoshow {{refName}} default Loading 4 branches 26 tags Code Loading Latestcommit MasterOdin cut2.11.0release(#1455) … e5b4d9d Aug27,2021 cut2.11.0release(#1455) e5b4d9d Gitstats 666 commits Files Permalink Failedtoloadlatestcommitinformation. Type Name Latestcommitmessage Committime .github Fixincorrectruby-versionparameterindeployGitHubActions(#1489) Jul28,2021 lib fixbcstylebreaksfromrouge3.x(#1226) May19,2020 source Updatejqueryto3.6.0(#1458) Jun17,2021 .dockerignore addinstructionstorunningdockertoREADME May11,2020 .editorconfig Updatelinkin.editorconfigtohttps(#1049) Oct20,2019 .gitattributes markfilesundersource/javascripts/libasvendoredbyGitHubstatistics Jun22,2020 .gitignore IgnoregeneratedlogfilefromrunningVagrant May11,2020 CHANGELOG.md cut2.11.0release(#1455) Aug27,2021 CODE_OF_CONDUCT.md CreateCODE_OF_CONDUCT.md Jul17,2017 Dockerfile AddgittoDockerfile(#1426) Apr8,2021 Gemfile Bumpnokogirifrom1.11.7to1.12.1(#1492) Aug3,2021 Gemfile.lock Bumpnokogirifrom1.12.1to1.12.3(#1496) Aug12,2021 LICENSE UsethefullApacheLicense2.0textinLICENSE Jan10,2020 README.md RemovescalefromREADMEexamples(#1363) Jan27,2021 Vagrantfile Fixvagrantissue:useexactversionofbundler(#1355) Dec17,2020 config.rb disableassethashforwoffandwoff2filesoutofthebox(#1231) May19,2020 deploy.sh master->main(#1264) Jun20,2020 font-selection.json Removeunusediconsfromthefont May31,2015 slate.sh Reworkdockerimagetobeeasiertousefordevelopmentanddeployment( Aug10,2020 Viewcode Features GettingStartedwithSlate CompaniesUsingSlate Questions?NeedHelp?Foundabug? Contributors README.md Slatehelpsyoucreatebeautiful,intelligent,responsiveAPIdocumentation. TheexampleabovewascreatedwithSlate.Checkitoutatslatedocs.github.io/slate. Features Clean,intuitivedesign—WithSlate,thedescriptionofyourAPIisontheleftsideofyourdocumentation,andallthecodeexamplesareontherightside.InspiredbyStripe'sandPayPal'sAPIdocs.Slateisresponsive,soitlooksgreatontablets,phones,andeveninprint. Everythingonasinglepage—Gonearethedayswhenyourusershadtosearchthroughamillionpagestofindwhattheywanted.Slateputstheentiredocumentationonasinglepage.Wehaven'tsacrificedlinkability,though.Asyouscroll,yourbrowser'shashwillupdatetothenearestheader,solinkingtoaparticularpointinthedocumentationisstillnaturalandeasy. SlateisjustMarkdown—WhenyouwritedocswithSlate,you'rejustwritingMarkdown,whichmakesitsimpletoeditandunderstand.EverythingiswritteninMarkdown—eventhecodesamplesarejustMarkdowncodeblocks. Writecodesamplesinmultiplelanguages—IfyourAPIhasbindingsinmultipleprogramminglanguages,youcaneasilyputintabstoswitchbetweenthem.Inyourdocument,you'lldistinguishdifferentlanguagesbyspecifyingthelanguagenameatthetopofeachcodeblock,justlikewithGitHubFlavoredMarkdown. Out-of-the-boxsyntaxhighlightingforover100languages,noconfigurationrequired. Automatic,smoothlyscrollingtableofcontentsonthefarleftofthepage.Asyouscroll,itdisplaysyourcurrentpositioninthedocument.It'sfast,too.We'reusingSlateatTripIttobuilddocumentationforournewAPI,whereourtableofcontentshasover180entries.We'vemadesurethattheperformanceremainsexcellent,evenforlargerdocuments. Letyourusersupdateyourdocumentationforyou—Bydefault,yourSlate-generateddocumentationishostedinapublicGitHubrepository.NotonlydoesthismeanyougetfreehostingforyourdocswithGitHubPages,butitalsomakesitsimpleforotherdeveloperstomakepullrequeststoyourdocsiftheyfindtyposorotherproblems.Ofcourse,ifyoudon'twanttouseGitHub,you'realsowelcometohostyourdocselsewhere. RTLSupportFullright-to-leftlayoutforRTLlanguagessuchasArabic,Persian(Farsi),Hebrewetc. GettingstartedwithSlateissupereasy!Simplypressthegreen"usethistemplate"buttonaboveandfollowtheinstructionsbelow.Or,ifyou'dliketocheckoutwhatSlateiscapableof,takealookatthesampledocs. GettingStartedwithSlate TogetstartedwithSlate,pleasecheckouttheGettingStarted sectioninourwiki. WesupportrunningSlateinthreedifferentways: Natively UsingVagrant UsingDocker CompaniesUsingSlate NASA Sony BestBuy Travis-CI Greenhouse WooCommerce Dwolla Clearbit Coinbase ParrotDrones Youcanviewmoreinthelistonthewiki. Questions?NeedHelp?Foundabug? Ifyou'vegotquestionsaboutsetup,deploying,specialfeatureimplementationinyourfork,orjustwanttochatwiththedeveloper,pleasefeelfreetostartathreadinourDiscussionstab! FoundabugwithupstreamSlate?Goaheadandsubmitanissue.And,ofcourse,feelfreetosubmitpullrequestswithbugfixesorchangestothedevbranch. Contributors SlatewasbuiltbyRobertLordwhileatTripIt.TheprojectisnowmaintainedbyMatthewPevelerandMikeRalphson. Thankstothefollowingpeoplewhohavesubmittedmajorpullrequests: @chrissrogers @bootstraponline @realityking @cvkef Also,thankstoSauceLabsforsponsoringthedevelopmentoftheresponsivestyles. About BeautifulstaticdocumentationforyourAPI slatedocs.github.io/slate Topics api static-site-generator api-documentation slate Resources Readme License Apache-2.0License Codeofconduct Codeofconduct Releases 25 Version2.11.0 Latest Aug27,2021 +24releases Packages0 Nopackagespublished Usedby4 Contributors124 +113contributors Languages SCSS 43.6% Shell 18.6% JavaScript 18.1% Ruby 12.4% HTML 6.5% Dockerfile 0.8% Youcan’tperformthatactionatthistime. Yousignedinwithanothertaborwindow.Reloadtorefreshyoursession. Yousignedoutinanothertaborwindow.Reloadtorefreshyoursession.