Skip to content

Nostromos/what.lol

what.lol

what.lol

Docusaurus React TypeScript Tailwind CSS shadcn/ui MDX

Overview

My personal portfolio and blog built with Docusaurus 3.8.1. A static site showcasing various projects, technical blog posts, and insights on career transitions in software development. Visit live at what.lol.

Features

  • Project Showcase: Interactive portfolio displaying various development projects
  • Blog Platform: Technical articles and career insights written in MDX
  • Documentation Hub: Comprehensive project documentation with auto-generated sidebars
  • Search Integration: Algolia-powered search for easy content discovery
  • Responsive Design: Mobile-first design with Infima framework
  • MDX Support: Rich, interactive content with embedded React components
  • Theme Support: Light/dark mode with system detection

Tech Stack

  • Docusaurus 3.8.1 - Static site generator for documentation sites
  • React 19 - Latest React with concurrent features
  • TypeScript - Type-safe development
  • Tailwind CSS - Utility-first styling with shadcn/ui components
  • MDX - Markdown with embedded JSX for rich content
  • CSS Modules - Component-scoped styling with Infima framework
  • Algolia - Search integration for content discovery

Requirements

  • Node.js 18.0 or higher
  • npm or pnpm

Installation

  1. Clone the repository:
git clone https://github.com/nostromos/what.lol.git
cd what.lol
  1. Install dependencies:
npm install
  1. Start the development server:
npm start

Visit http://localhost:3000 in your browser of choice.

Key Features

Content Management

  • Write blog posts in Markdown with frontmatter metadata
  • Create rich MDX pages with embedded React components
  • Organize project documentation with auto-generated sidebars
  • Add custom React components for interactive content

Project Showcase

  • Display projects with custom ProjectCard components
  • Tag projects by technology and category
  • Link to live demos and source code
  • Include detailed project documentation

Blog Platform

  • Write technical articles in Markdown/MDX
  • Automatic RSS feed generation
  • Tag-based categorization
  • Reading time estimates

Project Structure

what.lol/
├── blog/                  # Blog posts in Markdown
├── docs/                  # Project documentation
│   ├── dashboard-tifco/   # TIFCO Dashboard docs
│   ├── ggob/              # GGOB project docs
│   ├── notion-clone/      # Notion Clone docs
│   ├── qli/               # QLI project docs
│   └── RCScout/           # RC Scout docs
├── src/                   # Source code
│   ├── components/        # React components
│   │   ├── EnhancedLogo.tsx
│   │   ├── ProjectCard.tsx
│   │   ├── RCScout.tsx
│   │   ├── TagPill.tsx
│   │   └── ui/            # shadcn/ui components
│   ├── css/               # Global styles
│   ├── lib/               # Utilities
│   └── pages/             # MDX pages
│       ├── index.mdx      # Homepage
│       ├── about.mdx      # About page
│       ├── contact.mdx    # Contact page
│       └── projects.mdx   # Projects showcase
├── static/                # Static assets
├── docusaurus.config.ts   # Site configuration
├── sidebars.ts            # Sidebar config
└── CLAUDE.md              # AI assistant context

Development

Commands

# Start development server (port 3000)
npm start

# Build for production
npm build

# Serve production build locally
npm serve

# Type checking
npm run typecheck

# Deploy to GitHub Pages
npm run deploy

# Clear cache
npm run clear

Architecture Patterns

  • Static Site Generation: Pre-built pages for optimal performance
  • Component-based: Modular, reusable React components
  • MDX-driven: Rich content with embedded components
  • CSS Modules: Scoped styling with Infima framework
  • Type-safe: Full TypeScript coverage

Contributing

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

Future Enhancements

  • Newsletter integration (highly unlikely to do this)
  • Project demo videos
  • Interactive code snippets
  • Analytics dashboard
  • RSS feed enhancements
  • Multi-language support
  • Progressive Web App features

License

See LICENSE for more information.

Acknowledgments

Additional Resources

About

My personal site for projects and docs.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Contributors