Add Docusaurus documentation website with GitHub Pages deployment#53
Add Docusaurus documentation website with GitHub Pages deployment#53dennisdoomen merged 5 commits intomainfrom
Conversation
- Initialize Docusaurus in website/ directory - Configure branding with cyan-to-purple gradient matching logo - Convert README content to structured documentation pages - Add GitHub Actions workflow for GitHub Pages deployment - Update .gitignore for Docusaurus artifacts Co-authored-by: dennisdoomen <572734+dennisdoomen@users.noreply.github.com>
Co-authored-by: dennisdoomen <572734+dennisdoomen@users.noreply.github.com>
|
@copilot please add some command-line (Powershell) scripts to test the website locally |
- Start-DevServer.ps1: Start development server with hot-reloading - Build-Website.ps1: Build website for production - Test-ProductionBuild.ps1: Serve and test production build - Test-Website.ps1: Run comprehensive validation tests - Added detailed README with script usage and examples Co-authored-by: dennisdoomen <572734+dennisdoomen@users.noreply.github.com>
Added PowerShell scripts for local testing in commit fb258d4: Scripts included:
Usage examples: cd website
# Start dev server
.\Start-DevServer.ps1
# Build for production
.\Build-Website.ps1
# Test production build
.\Test-ProductionBuild.ps1 -Build
# Run tests
.\Test-Website.ps1All scripts include detailed help accessible via See the website README.md for complete documentation. |
There was a problem hiding this comment.
@copilot remove the duplicated documentation from the read-me and makes sure the documentation section points to the new docusaurus website
There was a problem hiding this comment.
Streamlined the README in commit 4501880:
Changes made:
- Removed 600+ lines of duplicated detailed documentation
- Added prominent Documentation section at top with direct links to:
- Quick Start guide
- Usage guide
- Advanced Features
- Building instructions
- Contributing guidelines
- Kept essential About, Key Features, and Quick Start sections
- Made Building and Contributing sections brief with links to full documentation
- Fixed logo alt text from "PackageGuard" to "Mockly"
The README is now 250 lines (down from 858) and serves as a landing page that directs users to the comprehensive documentation website at https://dennisdoomen.github.io/mockly/
- Removed duplicated detailed documentation content - Added prominent Documentation section with links to website - Kept About, Key Features, and Quick Start sections - Made Building and Contributing sections brief with links to full docs - Reduced from 858 to 250 lines for better maintainability - Fixed alt text for logo from "PackageGuard" to "Mockly" Co-authored-by: dennisdoomen <572734+dennisdoomen@users.noreply.github.com>
Pull Request Test Coverage Report for Build 22014300874Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
Adds a documentation website using Docusaurus to replace inline README documentation with a structured, searchable site deployable to GitHub Pages.
Changes
Documentation Structure
intro.md- Platform support and key featuresquick-start.md- Installation and basic examplesusage.md- Core functionality referenceadvanced.md- Custom matchers, body matching, assertionsbuilding.md- Build instructionscontributing.md- Guidelines and creditsBranding
#3BABD9(cyan) →#5B7DD8(blue) →#8B5FCE(purple)src/css/custom.cssfor hero section and color variablesDeployment
.github/workflows/deploy-docs.yml- Automated GitHub Actions workflowmainwhen website files changehttps://dennisdoomen.github.io/mockly/PowerShell Testing Scripts
Get-HelpRepository Updates
.gitignore- Excludeswebsite/build,website/.docusaurus,website/node_modulesScreenshots
Homepage with gradient hero and feature cards:

Documentation pages with sidebar navigation:

Deployment Setup
After merge, enable GitHub Pages:
Local Testing (Windows)
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.