') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); GitHub - reactiveui/website: ReactiveUI documentation and guidelines website. PR's welcome! 💖 · GitHub
Skip to content
BranchesTags

Repository files navigation

ReactiveUI Website

Build website

Source for the ReactiveUI website. Pages are rendered by NuStreamDocs — a .NET-native static-site generator that reads markdown + a NuGet manifest and emits a Material 3-themed site, including the API reference (extracted from the published packages via Roslyn + ICSharpCode.Decompiler).

The build is a single .NET 10 program (build/Program.cs) wired up with System.CommandLine. The .NET 10 SDK is the only prerequisite.

Quick start

./build.sh build # full build → site/
./build.sh build --strict # CI-style: fail on broken links / unresolved refs
./build.sh serve # watch + serve at http://127.0.0.1:8000
./build.sh serve --port 9000 # serve on a different port
./build.sh clean # wipe .api-cache/, build/_intermediate/, site/

build.ps1 (PowerShell) and build.cmd (Windows shim) are equivalent. With no verb, ./build.sh defaults to build.

Layout

website/
├── build/
│ ├── Program.cs System.CommandLine entry point + DocBuilder wiring
│ ├── WebsiteLogging.cs source-generated ILogger messages
│ ├── TerseConsoleFormatter.cs minimal log formatter
│ └── _build.csproj PackageReference set against NuStreamDocs
├── docs/ all source content
│ ├── index.md landing page
│ ├── documentation/ handbook + getting-started + guidelines
│ ├── articles/ curated articles
│ ├── Announcements/ chronological announcements
│ ├── contribute/ contributor guide
│ ├── stylesheets/ brand palette + hero CSS
│ └── images/, vs/ assets + Visual Studio screenshots
├── nuget-packages.json API-reference package list (consumed by NuStreamDocs)
├── Directory.Packages.props central NuStreamDocs version pin (one var)
├── .api-cache/ GENERATED — fetched NuGet assemblies + lib/refs trees
├── build/_intermediate/ GENERATED — extracted API markdown / yml / metadata
└── site/ GENERATED — rendered output (deployed to Netlify)

The three GENERATED paths are gitignored. clean wipes them.

Bumping NuStreamDocs

One line in Directory.Packages.props:

<NuStreamDocsVersion>1.3.0</NuStreamDocsVersion>

Every NuStreamDocs.*PackageVersion in the file references that property, so the version moves in lockstep across every plugin.

Local-iteration against an unpublished NuStreamDocs

build/_build.csproj contains a commented-out <ProjectReference> block that points at a sibling glennawatson/NuSourceDocs checkout. Uncomment that block (and comment out the <PackageReference> block above it) to build against live source instead of the published NuGet packages — useful when iterating on the renderer at the same time as the site.

Contributing

  1. Fork and clone the repo.
  2. Create a branch.
  3. ./build.sh serve — open http://127.0.0.1:8000 and iterate on the docs.
  4. PRs against main build under CI (actions/setup-dotnet@v5) and deploy to Netlify on merge.

For the renderer + API extraction internals see NuSourceDocs.

About

ReactiveUI documentation and guidelines website. PR's welcome! 💖

www.reactiveui.net/

Topics

aspnetcorehacktoberfestmeetupreactiveui

Resources

Readme
License
Activity
Custom properties

Stars

36 stars

Watchers

12 watching

Forks

123 forks
Report repository

Releases

Sponsor this project

Packages

Used by

Contributors

Languages