🌟 Why This Exists?

Managing documentation for a full-stack project is painful. Backend engineers use DocFX for C#, frontend engineers use Compodoc for Angular, and integrating them into a single, readable portal usually requires days of custom DevOps pipelines, messy IFrames, and conflicting CSS.

create-fullstack-docs solves this instantly. With a single interactive CLI command, it scaffolds a Docusaurus v3 portal, seamlessly integrates your Frontend and Backend API docs, and sets up live-watch auto-rebuilding. Zero configuration required.

✨ Core Features

• 🧠 Smart Architecture Agnostic: Works perfectly whether you use a Monorepo, multiple separate repositories, or a single folder. It dynamically calculates relative paths.
• ⚡ Zero-Interaction Execution: Uses -y flags for all npx scaffolding. No annoying prompts interrupting your CI/CD or setup flows.
• 🎨 Headless IFrame Integration: Automatically strips out the default headers and footers from DocFX when embedding into Docusaurus. No ugly double-scrollbars or nested navbars.
• 🔄 Live Hot-Reloading / Auto-build:
  • Frontend: Automatically injects concurrently into your Angular package.json to run compodoc:build alongside npm start.
  • Backend: Injects an MSBuild Target into your .csproj. Every time you press "Run" or dotnet build in Visual Studio, your C# documentation updates automatically.
• 🛠 Flexible Modes: Support for Full Stack, Frontend Only, and Backend Only documentation logic.

📦 Installation & Usage

You do not need to install this globally. Simply run it via npx from your terminal:

npx create-fullstack-docs

You will be greeted with an interactive prompt. Simply provide the paths to your Angular project, your .NET project, and where you want the Docusaurus portal to be generated.

Example: If your backend is in ./test-api and frontend is in ./test-app, just pass those relative paths when prompted. The tool handles the rest!

📖 Comprehensive Documentation

For a deep dive into how the tool manipulates your .csproj, how the custom DocFX templates work, and advanced troubleshooting, please read our official User Manual.

🤝 Contributing

Issues and Pull Requests are welcome! Feel free to contribute to making full-stack documentation effortless.

📜 License

MIT License