66 [ ![ License] ( https://img.shields.io/badge/license-AGPL--3.0-blue.svg )] ( https://github.com/dailydotdev/daily/blob/master/LICENSE )
77 [ ![ Contributors] ( https://img.shields.io/github/contributors/dailydotdev/docs )] ( https://github.com/dailydotdev/docs/graphs/contributors )
88 [ ![ Docker] ( https://img.shields.io/docker/v/francescoxx/dailydev-docs?label=docker )] ( https://hub.docker.com/r/francescoxx/dailydev-docs )
9+
10+ [ ![ React] ( https://img.shields.io/badge/React-18.3.1-61DAFB?style=flat&logo=react&logoColor=white )] ( https://reactjs.org/ )
11+ [ ![ Docusaurus] ( https://img.shields.io/badge/Docusaurus-3.4.0-3ECC5F?style=flat&logo=facebook&logoColor=white )] ( https://docusaurus.io/ )
12+ [ ![ Node.js] ( https://img.shields.io/badge/Node.js-20.12+-339933?style=flat&logo=node.js&logoColor=white )] ( https://nodejs.org/ )
13+ [ ![ Playwright] ( https://img.shields.io/badge/Playwright-1.40.0-2EAD33?style=flat&logo=playwright&logoColor=white )] ( https://playwright.dev/ )
14+ [ ![ ESLint] ( https://img.shields.io/badge/ESLint-8.57.0-4B32C3?style=flat&logo=eslint&logoColor=white )] ( https://eslint.org/ )
15+ [ ![ Prettier] ( https://img.shields.io/badge/Prettier-3.2.5-F7B93E?style=flat&logo=prettier&logoColor=white )] ( https://prettier.io/ )
16+
17+ [ ![ Build Status] ( https://img.shields.io/github/actions/workflow/status/dailydotdev/docs/ci.yml?branch=main&style=flat&logo=github )] ( https://github.com/dailydotdev/docs/actions )
18+ [ ![ Deployment] ( https://img.shields.io/github/deployments/dailydotdev/docs/production?style=flat&logo=vercel&label=deployment )] ( https://github.com/dailydotdev/docs/deployments )
19+ [ ![ Bundle Size] ( https://img.shields.io/bundlephobia/minzip/dailydev-docs?style=flat&logo=webpack&label=bundle%20size )] ( https://bundlephobia.com/package/dailydev-docs )
20+ [ ![ Code Quality] ( https://img.shields.io/codeclimate/maintainability/dailydotdev/docs?style=flat&logo=codeclimate )] ( https://codeclimate.com/github/dailydotdev/docs )
921</div >
1022
1123## 🎯 Overview
1224
1325This repository contains the comprehensive documentation for [ daily.dev] ( https://daily.dev ) , designed to help our community members get the most out of the platform. The documentation covers everything from getting started to advanced features and contribution guidelines.
1426
27+ <div align =" center " >
28+ <a href =" https://docs.daily.dev " target =" _blank " >
29+ <img src="https://img.shields.io/badge/🚀%20Try%20it%20Live-docs.daily.dev-blue?style=for-the-badge&logo=firefox&logoColor=white" alt="Try it Live" />
30+ </a >
31+ <a href =" https://gitpod.io/#https://github.com/dailydotdev/docs " target =" _blank " >
32+ <img src="https://img.shields.io/badge/🛠️%20Open%20in%20Gitpod-ready--to--code-908a85?style=for-the-badge&logo=gitpod" alt="Open in Gitpod" />
33+ </a >
34+ </div >
35+
1536### ✨ Key Features
1637
17- - ** 📖 Comprehensive Guides** : Complete coverage of daily.dev features and functionality
18- - ** 🔍 Algolia Search** : Fast, integrated search across all documentation
19- - ** 🌙 Dark/Light Mode** : Theme toggle for comfortable reading
20- - ** 📱 Responsive Design** : Optimized for all devices
21- - ** ✏️ Edit Links** : Direct GitHub integration for community contributions
22- - ** 🚀 Fast Performance** : Built with Docusaurus 3 for optimal speed
38+ - ** Comprehensive Guides** : Complete coverage of daily.dev features and functionality
39+ - ** Algolia Search** : Fast, integrated search across all documentation
40+ - ** Dark/Light Mode** : Theme toggle for comfortable reading
41+ - ** Responsive Design** : Optimized for all devices
42+ - ** Edit Links** : Direct GitHub integration for community contributions
43+ - ** Fast Performance** : Built with Docusaurus 3 for optimal speed
2344
2445## 📊 Performance Metrics
2546
2647Our documentation site is optimized for speed and performance:
2748
28- - ** Build Time** : ~ 45 seconds (production build)
29- - ** Bundle Size** : ~ 2.1MB (gzipped: ~ 580KB)
30- - ** Lighthouse Scores** :
31- - 🚀 Performance: 95+
32- - ♿ Accessibility: 100
33- - 🔍 SEO: 100
34- - 💡 Best Practices: 100
49+ <div align =" center " >
50+
51+ ![ Build Time] ( https://img.shields.io/badge/Build%20Time-~45s-green?style=flat&logo=github-actions )
52+ ![ Bundle Size] ( https://img.shields.io/badge/Bundle%20Size-~2.1MB-blue?style=flat&logo=webpack )
53+ ![ Gzipped] ( https://img.shields.io/badge/Gzipped-~580KB-lightgreen?style=flat&logo=7zip )
54+
55+ ** 🚀 Lighthouse Scores:**
56+
57+ ![ Performance] ( https://img.shields.io/badge/Performance-95+-brightgreen?style=flat&logo=lighthouse )
58+ ![ Accessibility] ( https://img.shields.io/badge/Accessibility-100-brightgreen?style=flat&logo=lighthouse )
59+ ![ SEO] ( https://img.shields.io/badge/SEO-100-brightgreen?style=flat&logo=lighthouse )
60+ ![ Best Practices] ( https://img.shields.io/badge/Best%20Practices-100-brightgreen?style=flat&logo=lighthouse )
61+
62+ </div >
3563
3664## 🚀 Quick Start
3765
3866### Prerequisites
3967
40- - ** Node.js** : v18.0 or higher
68+ - ** Node.js** : v20.12 or higher
4169- ** npm** : v7.0 or higher (or yarn/pnpm equivalent)
4270
4371### Development Setup
@@ -59,16 +87,44 @@ npm start
5987
6088The site will be available at ` http://localhost:3000 ` with hot reload enabled.
6189
90+ ### 🛠️ Developer Experience
91+
92+ ** One-Click Setup:**
93+ - [ ![ Open in Gitpod] ( https://gitpod.io/button/open-in-gitpod.svg )] ( https://gitpod.io/#https://github.com/dailydotdev/docs )
94+ - [ ![ Open with CodeSandbox] ( https://assets.codesandbox.io/github/button-edit-lime.svg )] ( https://codesandbox.io/s/github/dailydotdev/docs )
95+
96+ ** VSCode Integration:**
97+ ``` bash
98+ # Recommended extensions are auto-suggested
99+ # Settings and tasks are pre-configured in .vscode/
100+ code .
101+ ```
102+
103+ ** Development Tools:**
104+ - 🔥 Hot reload with instant feedback
105+ - 🔍 Built-in link validation
106+ - 📝 MDX syntax highlighting
107+ - 🎨 Real-time preview
108+ - 🧪 Integrated testing with Playwright
109+
62110## 📋 Available Scripts
63111
64112| Command | Description |
65113| ---------| -------------|
66114| ` npm start ` | Start development server |
67115| ` npm run build ` | Build for production |
116+ | ` npm run build:optimized ` | Build with optimizations |
68117| ` npm run serve ` | Serve built site locally |
69118| ` npm run clear ` | Clear Docusaurus cache |
70119| ` npm run docker:compose ` | Build and run with Docker Compose |
71120| ` npm run docker:run ` | Run pre-built Docker image |
121+ | ` npm test ` | Run Playwright tests |
122+ | ` npm run test:headed ` | Run Playwright tests in headed mode |
123+ | ` npm run test:ui ` | Run Playwright tests with UI |
124+ | ` npm run lint ` | Run ESLint on source files |
125+ | ` npm run lint:fix ` | Run ESLint with auto-fix |
126+ | ` npm run format ` | Format code with Prettier |
127+ | ` npm run format:check ` | Check code formatting |
72128
73129## 🐳 Docker Development
74130
@@ -79,7 +135,7 @@ docker compose up --build
79135
80136### Using Pre-built Image
81137``` bash
82- docker run -p 3000:3000 francescoxx/dailydev-docs:0.9.3
138+ docker run -p 3000:3000 francescoxx/dailydev-docs:0.19.0
83139```
84140
85141Both methods serve the site on ` http://localhost:3000 ` .
@@ -88,17 +144,24 @@ Both methods serve the site on `http://localhost:3000`.
88144
89145### Running Tests
90146
91- Currently, the project uses the following quality assurance processes:
147+ The project uses Playwright for end-to-end testing and additional quality assurance processes:
92148
93149``` bash
150+ # Run Playwright tests
151+ npm test
152+
153+ # Run tests in headed mode (with browser UI)
154+ npm run test:headed
155+
156+ # Run tests with Playwright UI
157+ npm run test:ui
158+
94159# Build test (validates all content can be built)
95160npm run build
96161
97- # Link checking (validates all internal and external links)
98- npm run build && npm run serve # Manual verification recommended
99-
100- # Markdown linting (if configured)
101- npm run lint # Check for linting scripts in package.json
162+ # Code linting and formatting
163+ npm run lint
164+ npm run format:check
102165```
103166
104167### Quality Checks
0 commit comments