Telerik® UI for Blazor Components Documentation
Welcome to the GitHub repo for the Telerik UI for Blazor components documentation. This repository contains the source content — written in Markdown — that we use to power Telerik® UI for Blazor Documentation at http://docs.telerik.com/blazor-ui/introduction.
If you've arrived here wanting to search and peruse our docs, you'd be better served heading over to the officially published UI for Blazor components documentation where our content is prettified and searchable.
Contribution
Pull Requests are welcome! If you see mistakes or missing info, fix it in a Pull Request (you may need to fork the repo for something larger than a typo you can fix online), or open an Issue. This will help everyone have better documentation.
Offline PDF Version
You can download a PDF with this documentation from your telerik.com account. Go to the Downloads section, navigate to UI for Blazor, choose the version you want from the dropdown, and get the PDF file under the Documentation section.
Running Locally
You can generate a static web site from the Telerik® UI for Blazor documentation and browse it locally.
- Clone the repository
git clone [email protected]:telerik/blazor-docs.git - Go to the https://github.com/telerik/docs-seed repo and follow the instructions from its own readme file
If you want to keep the local documentation alive after closing the prompt, you can add the _site folder that was generated to a server of your choice. Make sure that it is under a path like serverName/blazor-ui. You can find sample instructions in the following page, and they are applicable for IIS, even though they are written for the UI for ASP.NET AJAX docs where we have two nests folders instead of one: https://github.com/telerik/ajax-docs/wiki/Deploying-Documentation-on-IIS.
Useful Links
- Browse all UI for Blazor component demos live
- Browse the Telerik UI for Blazor documentation
- Follow this link to report bugs and add feature requests
- Browse or contribute to localization texts used in the samples
- Create, run, share and test Blazor code snippets directly in the browser in our Blazor REPL code runner
License
The Telerik® UI for Blazor Documentation is licensed under an MIT license. This license applies to the markdown (.md) files in this site ONLY, and does not convey, override or modify any existing licenses covering the runtime source and components of Telerik® UI for Blazor. For information about available licenses for the Telerik® UI for Blazor click here.
If you don't have a license, start a free trial and then follow the first steps articles for:
MIT License
Copyright (c) 2012-2022 Telerik
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software" ), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.