CINXE.COM

Cake - Home

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta name="description" /> <meta name="keywords" content="static content generator,static site generator,static site,HTML,web development,.NET,C#,Razor,Markdown,YAML" /> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <link rel="shortcut icon" href="/assets/img/favicon.ico" type="image/x-icon"> <link rel="icon" href="/assets/img/favicon.ico" type="image/x-icon"> <title>Cake - Home</title> <link href="/assets/css/highlight.css" rel="stylesheet"> <link href="/assets/css/bootstrap/bootstrap.css" rel="stylesheet" /> <link href="/assets/css/adminlte/AdminLTE.css" rel="stylesheet" /> <link href="/assets/css/theme/theme.css" rel="stylesheet" /> <link href="//fonts.googleapis.com/css?family=Roboto+Mono:400,700|Roboto:400,400i,700,700i" rel="stylesheet"> <link href="/assets/css/font-awesome.min.css" rel="stylesheet" type="text/css"> <link href="/assets/css/override.css" rel="stylesheet" /> <script src="/assets/js/jquery-2.2.3.min.js"></script> <script src="/assets/js/bootstrap.min.js"></script> <script src="/assets/js/app.min.js"></script> <script src="/assets/js/highlight.pack.js"></script> <script src="/assets/js/jquery.slimscroll.min.js"></script> <script src="/assets/js/jquery.sticky-kit.min.js"></script> <script src="/assets/js/mermaid.min.js"></script> <script src="/assets/js/svg-pan-zoom.min.js"></script> <!--[if lt IE 9]> <script src="/assets/js/html5shiv.min.js"></script> <script src="/assets/js/respond.min.js"></script> <![endif]--> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" /> <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script> <script type="text/javascript" src="/assets/js/anchor.min.js"></script> <link href="https://dotnet.social/@cakebuild" rel="me"> <link href="https://dotnet.social/@cakecontrib" rel="me"> </head> <body class="hold-transition wyam layout-boxed layout-top-nav no-gutter"> <div class="top-banner"></div> <div class="wrapper"> <!-- Header --> <header class="main-header"> <a href="/" class="logo"> <!-- mini logo for sidebar mini 50x50 pixels --> <span class="logo-mini"><img src="/assets/img/logo.png"></span> <!-- logo for regular state and mobile devices --> <span class="logo-lg"><img src="/assets/img/logo.png"></span> </a> <nav class="navbar navbar-static-top" role="navigation"> <!-- Sidebar toggle button--> <div class="navbar-header"> <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-collapse"> <span class="sr-only">Toggle side menu</span> <i class="fa fa-chevron-circle-down"></i> </button> </div> <!-- Collect the nav links, forms, and other content for toggling --> <div class="collapse navbar-collapse pull-left" id="navbar-collapse"> <ul class="nav navbar-nav"> <div class="navbar-right navbar-form"> <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off" autofocus> </div> <li><a href="/blog">Blog</a></li> <li><a href="/docs">Documentation</a></li> <li><a href="/dsl">Reference</a></li> <li><a href="/extensions">Extensions</a></li> <li><a href="/community">Community</a></li> <li><a href="/api">API</a></li> <li><a href="https://opencollective.com/cake"><i class="fa-solid fa-heart"></i> Support Us</a></li> <li><a href="https://github.com/cake-build"><i class="fa-brands fa-github"></i> Source</a></li> </ul> </div> <!-- /.navbar-collapse --> <!-- Navbar Right Menu --> </nav> </header> <!-- Left side column. contains the logo and sidebar --> <aside class="main-sidebar hidden"> <section class="infobar" data-spy="affix" data-offset-top="60" data-offset-bottom="200"> <div><p><a href="https://github.com/cake-build/website/blob/master/input/index.cshtml"><i class="fa fa-pencil-square" aria-hidden="true"></i> Edit Content</a></p></div> <div id="infobar-headings"></div> </section> <section class="sidebar"> <ul class="sidebar-menu"> </ul> </section> </aside> <!-- Content Wrapper. Contains page content --> <div class="content-wrapper"> <div class="alert-latest-version"> <a href="/blog/2024/11/cake-v5.0.0-released">Cake 5.0.0 is now available</a> </div> <div class="jumbotron"> <div class="container"> <div class="row"> <div class="col-xs-12 col-sm-6"> <h1>What is Cake?</h1> <p> Cake (C# Make) is a free and open source cross-platform build automation system with a C# DSL for tasks such as compiling code, copying files and folders, running unit tests, compressing files and building NuGet packages. </p> <p> <a class="btn btn-primary btn-lg" href="/docs/getting-started" role="button">Get Started &raquo;</a> <a class="btn btn-primary btn-lg" href="/community" role="button">Get Involved &raquo;</a> <a class="btn btn-primary btn-lg" href="https://github.com/cake-build/cake" role="button" target="_blank"><i class="fa-solid fa-star"></i> Star on GitHub</a> </p> </div> <div class="col-sm-6 hidden-xs"> <img style="width: 360px;float: right;" src="/assets/img/screenshot.png" alt=""/> </div> </div> </div> </div> <div class="container content text-center"> <div class="row slideanim"> <div class="col-sm-4"> <h3 class="no-anchor">Familiar</h3> <p> Cake is built on top of the Roslyn compiler which enables you to write your build scripts in pure C# in either a standard console project, using <a href="docs/running-builds/runners/cake-frosting">Cake Frosting</a>, or as Cake script using <a href="docs/running-builds/runners/dotnet-tool">Cake .NET Tool</a>. </p> </div> <div class="col-sm-4"> <h3 class="no-anchor">Cross platform &amp; cross runtime</h3> <p> Cake runs on modern .NET platform and is available on Windows, Linux and macOS. See <a href="docs/running-builds/runners">Runners</a> for a list of available runners. </p> </div> <div class="col-sm-4"> <h3 class="no-anchor">IDE integration</h3> <p> Cake can run as simple console applications with full IDE integration including IntelliSense or refactoring. There are extensions available to provide advanced features for most popular IDEs and editors. See <a href="docs/integrations/editors">Editors</a> for detailed feature list. </p> </div> <div class="col-sm-4"> <h3 class="no-anchor">Reliable</h3> <p> Regardless if you're building on your own machine, or building on a CI system such as <a href="docs/integrations/build-systems/azure-pipelines">Azure Pipelines</a>, <a href="docs/integrations/build-systems/github-actions">GitHub Actions</a>, <a href="docs/integrations/build-systems/teamcity">TeamCity</a> or <a href="docs/integrations/build-systems/jenkins">Jenkins</a>, Cake is built to behave in the same way. See <a href="docs/integrations/build-systems">Build Systems</a> for a full list. </p> </div> <div class="col-sm-4"> <h3 class="no-anchor">Batteries included</h3> <p> Cake supports the most common tools used during builds such as MSBuild, .NET CLI, MSTest, xUnit, NUnit, NuGet, ILMerge, WiX and SignTool out of the box and many more through an ever growing list of <a href="/extensions">addins and modules</a>. </p> </div> <div class="col-sm-4"> <h3 class="no-anchor">Open source & community backed</h3> <p> Cake will always be free and open source, even for commercial use. If you want to support us we accept <a href="https://opencollective.com/cake" target="_blank">donations</a>. There's an amazing community around Cake with <a href="community/thanks">several hundred contributors</a> which are involved in the project and we would love to <a href="community">have you on board too</a>. </p> </div> </div> </div> </div> <!-- Footer --> <footer class="main-footer"> </footer> </div> <div class="wrapper bottom-wrapper"> <footer class="bottom-footer"> <p class="text-muted"> <a href="https://github.com/cake-build/cake" target="_blank" title="Cake on GitHub"><i class="fa-brands fa-github"></i> GitHub</a> | <a href="https://x.com/cakebuildnet" target="_blank" title="Cake on X"><i class="fa-brands fa-x-twitter"></i></a> | <a href="https://dotnet.social/@cakebuild" target="_blank" title="Cake in the Fediverse (Mastodon)"><i class="fa-brands fa-mastodon"></i></a> | <a href="https://bsky.app/profile/cakebuild.net" title="Cake on Bluesky" target="_blank"><i class="fa-brands fa-bluesky"></i></a> <br/> Copyright &copy; <a href="http://dotnetfoundation.org" target="_blank">.NET Foundation</a> and contributors. <br/> Generated by <a href="https://github.com/Wyamio/Wyam" target="_blank">Wyam</a> </p> </footer> </div> <a href="javascript:" id="return-to-top"><i class="fa fa-chevron-up"></i></a> <!-- Search --> <script type="text/javascript"> docsearch({ apiKey: '7c45d75e5cd2fddcb761d830d2b8ee27', indexName: 'cakebuild', inputSelector: '#search-query', debug: false, algoliaOptions: { hitsPerPage: 10 } }); </script> <!-- Tooltip initialization --> <script> $(function () { $('[data-toggle="tooltip"]').tooltip() }) </script> <!-- Anchor configuration --> <script> // Allow to set ".no-anchor" class to not have an anchor on an element. anchors.add('.content h1:not(.no-anchor), .content h2:not(.no-anchor), .content h3:not(.no-anchor), .content h4:not(.no-anchor)'); </script> <!-- Copy to clipboard functionality for code blocks --> <script type="text/javascript" src="/assets/js/clipboard.min.js"></script> <script type="text/javascript"> var snippets = document.querySelectorAll("pre > code"); [].forEach.call(snippets, function(snippet) { snippet.insertAdjacentHTML("beforebegin", "<button class='btn-copy' data-clipboard-snippet><img class='clippy' width=13 src='/assets/img/clippy.svg' alt='Copy to clipboard'></button>"); }); var clipboardSnippets = new Clipboard('[data-clipboard-snippet]', { target: function(trigger) { return trigger.nextElementSibling; } }); clipboardSnippets.on('success', function(e) { e.clearSelection(); showTooltip(e.trigger, "Copied!"); }); clipboardSnippets.on('error', function(e) { showTooltip(e.trigger, fallbackMessage(e.action)); }); var btns = document.querySelectorAll('.btn-copy'); for (var i = 0; i < btns.length; i++) { btns[i].addEventListener('mouseleave', function(e) { e.currentTarget.setAttribute('class', 'btn-copy'); e.currentTarget.removeAttribute('aria-label'); }); } function showTooltip(elem, msg) { elem.setAttribute('class', 'btn-copy tooltipped tooltipped-s'); elem.setAttribute('aria-label', msg); } function fallbackMessage(action) { var actionMsg = ''; var actionKey = (action === 'cut' ? 'X' : 'C'); if (/iPhone|iPad/i.test(navigator.userAgent)) { actionMsg = 'No support :('; } else if (/Mac/i.test(navigator.userAgent)) { actionMsg = 'Press ⌘-' + actionKey + ' to ' + action; } else { actionMsg = 'Press Ctrl-' + actionKey + ' to ' + action; } return actionMsg; } </script> <script> // Close the sidebar if we select an anchor link $(".main-sidebar a[href^='#']:not('.expand')").click(function(){ $(document.body).removeClass('sidebar-open'); }); $(document).ready(function() { mermaid.initialize( { flowchart: { useMaxWidth: false }, startOnLoad: false, cloneCssStyles: false }); mermaid.init(undefined, ".mermaid"); // Remove the max-width setting that Mermaid sets var mermaidSvg = $('.mermaid svg'); mermaidSvg.addClass('img-responsive'); mermaidSvg.css('max-width', ''); // Make it scrollable var target = document.querySelector(".mermaid svg"); if(target !== null) { var panZoom = window.panZoom = svgPanZoom(target, { zoomEnabled: true, controlIconsEnabled: true, fit: true, center: true, maxZoom: 20, zoomScaleSensitivity: 0.6 }); // Do the reset once right away to fit the diagram panZoom.resize(); panZoom.fit(); panZoom.center(); $(window).resize(function(){ panZoom.resize(); panZoom.fit(); panZoom.center(); }); } $('pre code').each(function(i, block) { hljs.highlightBlock(block); }); }); hljs.initHighlightingOnLoad(); // Back to top $(window).scroll(function() { if ($(this).scrollTop() >= 200) { // If page is scrolled more than 50px $('#return-to-top').fadeIn(1000); // Fade in the arrow } else { $('#return-to-top').fadeOut(1000); // Else fade out the arrow } }); $('#return-to-top').click(function() { // When arrow is clicked $('body,html').animate({ scrollTop : 0 // Scroll to top of body }, 500); }); </script> </body> </html>

Pages: 1 2 3 4 5 6 7 8 9 10