FlowingDocs

Technical Documentation & Knowledge Sharing

"Knowledge flows, value grows."

📖 About

FlowingDocs is a personal technical blog and documentation platform designed for Technical Writing, Developer Experience (DX), and AI-Assisted Creation.

Built with the philosophy that knowledge should be fluid and accessible, this project serves as both a content repository and a technical playground for exploring modern documentation engineering.

✨ Features

• 🚀 Modern Tech Stack: Built with Docusaurus v3, React, and TypeScript.
• 🎨 Beautiful UI: Clean, responsive design with automatic Dark Mode support using TailwindCSS.
• 🔍 Full-Text Search: Integrated Algolia DocSearch for instant content retrieval.
• 💬 Interactive Comments: Powered by Giscus (GitHub Discussions) for community engagement.
• 📱 PWA Support: Installable as a desktop/mobile app with offline reading capabilities.
• 🌍 Internationalization: Native support for i18n (Chinese/English).
• 📊 Analytics: Integrated Google Analytics 4 for visitor insights.

🛠️ Tech Stack

• Framework: Docusaurus v3
• Styling: TailwindCSS & Custom CSS
• Search: Algolia
• Hosting: Netlify
• Comments: Giscus

🚀 Getting Started

Prerequisites

• Node.js (version 20.0 or above)
• pnpm (recommended) or npm

Installation

1. Clone the repository

   git clone https://github.com/heywalter/flowingdocs.git
   cd flowingdocs

2. Install dependencies

   npm install
   # or pnpm install

3. Start the development server

   npm start
   # or pnpm start

   The site will open automatically at http://localhost:3000.

📂 Project Structure

flowingdocs/
├── blog/             # Blog posts & authors config
├── docs/             # Knowledge base (structured docs)
├── data/             # Static data (features, friends, social)
├── i18n/             # Internationalization translations
├── src/
│   ├── components/   # Custom React components
│   ├── css/          # Custom global styles
│   ├── pages/        # Standalone pages (Home, About, etc.)
│   └── theme/        # Swizzled Docusaurus theme components
├── static/           # Static assets (Images, favicons)
├── docusaurus.config.ts  # Main configuration
└── tailwind.config.ts    # Tailwind CSS configuration

🤝 Contributing

Contributions are welcome! If you find a typo or want to improve a section:

1. Fork the project
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📄 License

• Source Code: Licensed under the MIT License.
• Content: Licensed under CC BY-NC 4.0.

---

Created with ❤️ by Walter Gui

GitHub