Guides
Each guide takes one task from start to finish: what you need first, numbered steps with commands and code you can copy, and a check that it worked. For the parameters of a single component, use the component reference instead.
| Guide | What it covers |
|---|---|
| Getting started | A running blog from the osirion-blog template, or Osirion.Blazor added to an existing Blazor Web App |
| Install Osirion.Blazor | The packages, AddOsirion, the stylesheet links and the CSS framework choice for an existing Blazor Web App |
| Configure Osirion.Blazor | The Osirion section, configuring in code, per environment, secrets and what is validated at startup |
| Content providers | The file system and GitHub providers: options, the default provider, locales, the GitHub token and refresh |
| Deploy an Osirion.Blazor site | Publishing with content, environment settings, HTTPS behind a proxy, the public address, sitemap and feeds |
| How content is organized | Folders, _index.md, slugs and addresses, ordering, drafts and redirect_from redirects |
| Front matter reference | Every front matter key with its type, default and effect, seo_properties, dates and custom_fields |
| Localization | Language folders, translations, locale routes, hreflang links and the limits that exist today |
| SEO | What the library writes for search engines, the sitemap and feeds, redirects, and a checklist for a new site |
| Accessibility | What the components do for keyboard and screen reader users, the checks the repository runs, how to test your own site, and what stays your job |
| Security | Content and URL sanitizing, raw HTML parameters, a Content Security Policy, cookie flags, secrets, the contact form honeypot, rate limiting and antiforgery |
| Migration | Upgrading from 3.x to 4.0 and from 4.0 to 4.1: what changed and the code to change |
| Troubleshooting | Symptom, cause and fix for the problems a site is most likely to hit, taken from the library's own log messages |