DevDocs Cheat Feuille

Copier toutes les commandes Générer PDF

Aperçu général

DevDocs est un navigateur de documentation d'API rapide et hors ligne qui combine plusieurs références de développeurs dans une interface unique et consultable. Il fournit un accès instantané à la documentation pour des centaines de langages de programmation, cadres et outils avec des capacités de recherche puissantes et des fonctionnalités hors ligne.

C'est pas vrai. Note: Libre d'utilisation à devdocs.io. Source ouverte et auto-portable.

Commencer

Interface Web

# Access DevDocs:
# Visit: https://devdocs.io
# No account required
# Works in any modern browser
# Responsive design for mobile/tablet

# First-time setup:
# 1. Browse available documentation
# 2. Enable desired documentation sets
# 3. Configure preferences
# 4. Start searching and browsing

Utilisation hors ligne

# Enable offline access:
# 1. Click "Offline" in the sidebar
# 2. Select documentation to download
# 3. Wait for download completion
# 4. Access without internet connection

# Offline features:
# - Full documentation content
# - Search functionality
# - Bookmarks and history
# - Custom settings
# - Automatic updates when online
```_

### Applications de bureau
```bash
# Unofficial desktop applications:
# - DevDocs Desktop (Electron-based)
# - Zeal (Windows/Linux)
# - Dash (macOS)
# - Velocity (Windows)

# Installation:
# Download from respective websites
# Import DevDocs documentation
# Configure shortcuts and preferences
```_

## Navigation et interface

### Interface principale
```bash
# Interface components:
# - Sidebar: Documentation list and search
# - Main content: Documentation pages
# - Search bar: Global search across all docs
# - Settings: Preferences and configuration
# - Offline indicator: Download status

# Sidebar sections:
# - Enabled docs: Active documentation sets
# - Disabled docs: Available but not enabled
# - Search results: When searching
# - Table of contents: Current page structure

Gestion des documents

# Enable documentation:
# 1. Click on documentation name
# 2. Toggle switch to enable
# 3. Documentation loads automatically
# 4. Appears in enabled list

# Disable documentation:
# 1. Find in enabled list
# 2. Click settings icon
# 3. Toggle off or remove
# 4. Frees up storage space

# Popular documentation sets:
# - JavaScript, Python, Java, C++
# - React, Vue, Angular, Node.js
# - HTML, CSS, Bootstrap
# - Git, Docker, Kubernetes
# - AWS, Google Cloud, Azure

Fonctionnalité de la recherche

Recherche fondamentale

# Search methods:
# - Type in search bar
# - Use keyboard shortcut (/)
# - Click on search suggestions
# - Browse by category

# Search scope:
# - All enabled documentation
# - Current documentation only
# - Specific documentation set
# - Page content and titles

Recherche avancée

# Search operators:
javascript array          # Search in JavaScript docs
css @media                # Search for @media in CSS
python def                # Search for function definitions
react hooks               # Search React hooks

# Search filters:
# - By documentation type
# - By content category
# - By API method type
# - By language feature

Conseils de recherche

# Effective searching:
# - Use specific terms
# - Include context keywords
# - Try multiple variations
# - Use abbreviations
# - Search by method/function names

# Quick access:
# - Recent searches saved
# - Autocomplete suggestions
# - Keyboard navigation
# - Direct URL access

Raccourcis clavier

# Global shortcuts:
/                         # Focus search
Escape                    # Clear search/close
Ctrl/Cmd + /              # Toggle sidebar
Alt + R                   # Go to homepage
Alt + Left/Right          # Navigate history

# Search shortcuts:
Tab                       # Navigate suggestions
Enter                     # Open selected result
Ctrl/Cmd + Enter          # Open in new tab
Up/Down arrows            # Navigate results

# Content navigation:
J/K                       # Next/previous section
G G                       # Go to top
G Shift+G                 # Go to bottom
Ctrl/Cmd + F              # Find in page
N/Shift+N                 # Next/previous search result

# Sidebar navigation:
Alt + S                   # Focus sidebar
Alt + C                   # Toggle table of contents
Alt + T                   # Focus documentation list

Signets et historique

# Bookmark shortcuts:
Ctrl/Cmd + D              # Bookmark current page
Ctrl/Cmd + Shift + D      # Manage bookmarks
Alt + B                   # Toggle bookmarks

# History shortcuts:
Alt + H                   # Show history
Ctrl/Cmd + H              # Clear history
Ctrl/Cmd + Shift + H      # History search

Personnalisation et paramètres

Paramètres d'apparence

# Theme options:
# - Light theme (default)
# - Dark theme
# - Auto (system preference)
# - Custom CSS support

# Layout options:
# - Sidebar width adjustment
# - Font size scaling
# - Line height adjustment
# - Content width limits

Configuration de la recherche

# Search settings:
# - Search suggestions count
# - Fuzzy search tolerance
# - Search result grouping
# - Auto-complete behavior
# - Search history length

# Performance settings:
# - Search debounce delay
# - Result rendering limit
# - Memory usage optimization
# - Cache management

Personnalisation du clavier

# Shortcut customization:
# - Modify existing shortcuts
# - Add custom key bindings
# - Disable unwanted shortcuts
# - Export/import configurations
# - Reset to defaults

# Accessibility options:
# - High contrast mode
# - Keyboard-only navigation
# - Screen reader support
# - Focus indicators
# - Skip links

Documentation populaire Ensembles

Langues de programmation

# Core languages:
# - JavaScript (ES6+, Node.js)
# - Python (3.x, 2.7)
# - Java (8, 11, 17)
# - C++ (14, 17, 20)
# - C# (.NET Core, Framework)
# - Go (latest)
# - Rust (stable)
# - PHP (7.x, 8.x)

# Scripting languages:
# - Bash
# - PowerShell
# - Ruby
# - Perl
# - Lua

Technologies du Web

# Frontend frameworks:
# - React (latest)
# - Vue.js (2.x, 3.x)
# - Angular (latest)
# - Svelte
# - Ember.js

# CSS frameworks:
# - Bootstrap (4.x, 5.x)
# - Tailwind CSS
# - Bulma
# - Foundation
# - Materialize

# Build tools:
# - Webpack
# - Vite
# - Parcel
# - Rollup
# - Gulp

Backend et bases de données

# Backend frameworks:
# - Express.js
# - Django
# - Flask
# - Spring Boot
# - Ruby on Rails
# - Laravel

# Databases:
# - MongoDB
# - PostgreSQL
# - MySQL
# - Redis
# - Elasticsearch
# - SQLite

DevOps et Cloud

# Container technologies:
# - Docker
# - Kubernetes
# - Docker Compose
# - Podman

# Cloud platforms:
# - AWS
# - Google Cloud
# - Azure
# - DigitalOcean
# - Heroku

# CI/CD tools:
# - GitHub Actions
# - GitLab CI
# - Jenkins
# - Travis CI

Caractéristiques avancées

Documentation personnalisée

# Add custom documentation:
# 1. Prepare documentation in supported format
# 2. Host documentation online
# 3. Add custom source URL
# 4. Configure parsing rules
# 5. Enable in documentation list

# Supported formats:
# - HTML with proper structure
# - Markdown with metadata
# - JSON API documentation
# - OpenAPI/Swagger specs

Patterns d'URL et liaison profonde

# URL structure:
https://devdocs.io/javascript/array/map
https://devdocs.io/python~3.9/library/os
https://devdocs.io/css/media_queries

# Deep linking benefits:
# - Share specific documentation pages
# - Bookmark exact locations
# - Reference in external documents
# - Integrate with other tools

Intégration du navigateur

# Browser extensions:
# - Chrome DevDocs extension
# - Firefox DevDocs add-on
# - Safari DevDocs extension

# Extension features:
# - Right-click search
# - Omnibox integration
# - Quick access shortcuts
# - Context menu options

Auto-hébergement et déploiement

Installation locale

# Requirements:
# - Ruby 2.7+
# - Git
# - Modern web browser

# Installation steps:
git clone https://github.com/freeCodeCamp/devdocs.git
cd devdocs
bundle install
thor docs:download --all
bundle exec rackup

# Access at http://localhost:9292

Déploiement Docker

# Docker setup:
docker pull thibaut/devdocs
docker run -d \
  --name devdocs \
  -p 9292:9292 \
  thibaut/devdocs

# Custom configuration:
docker run -d \
  --name devdocs \
  -p 9292:9292 \
  -v /path/to/config:/app/config \
  thibaut/devdocs

Déploiement de la production

# Nginx configuration:
server {
    listen 80;
    server_name docs.yourcompany.com;

    location / {
        proxy_pass http://localhost:9292;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

# SSL setup:
# Use Let's Encrypt or your SSL certificate
# Configure HTTPS redirect
# Set security headers

API et intégration

API URL

# Direct documentation access:
# Format: https://devdocs.io/{doc}/{path}
# Examples:
https://devdocs.io/javascript/array/map
https://devdocs.io/python~3.9/library/json
https://devdocs.io/react/hooks-state

# Search API:
# Format: https://devdocs.io/search?q={query}
# Returns JSON results
# Supports JSONP callback

Automatisation du navigateur

// Puppeteer example
const puppeteer = require('puppeteer');

async function searchDevDocs(query) {
  const browser = await puppeteer.launch();
  const page = await browser.newPage();

  await page.goto('https://devdocs.io');
  await page.type('input[type="search"]', query);
  await page.keyboard.press('Enter');

  await page.waitForSelector('.list-result');
  const results = await page.evaluate(() => {
    return Array.from(document.querySelectorAll('.list-result')).map(el => ({
      title: el.querySelector('.list-text').textContent,
      url: el.href
    }));
  });

  await browser.close();
  return results;
}

Intégration IDE

# VS Code integration:
# - DevDocs extension available
# - Hover documentation
# - Quick search commands
# - Sidebar integration

# Vim integration:
# - DevDocs.vim plugin
# - :DD command for search
# - Keyword lookup
# - Split window display

# Emacs integration:
# - devdocs-lookup package
# - M-x devdocs-search
# - Company backend
# - Helm integration

Utilisation mobile

Application Web mobile

# Mobile features:
# - Responsive design
# - Touch navigation
# - Offline support
# - Search optimization
# - Bookmark sync

# Mobile shortcuts:
# - Swipe navigation
# - Pull to refresh
# - Long press menus
# - Voice search (browser dependent)

Application Web progressive

# PWA features:
# - Add to home screen
# - Offline functionality
# - Push notifications
# - Background sync
# - App-like experience

# Installation:
# 1. Visit devdocs.io on mobile
# 2. Browser prompts for installation
# 3. Add to home screen
# 4. Launch as standalone app

Optimisation des performances

Chargement des performances

# Optimization techniques:
# - Enable only needed documentation
# - Use offline mode for frequently accessed docs
# - Clear cache periodically
# - Disable unused features
# - Use fast internet connection for initial setup

# Memory management:
# - Limit enabled documentation sets
# - Clear search history regularly
# - Close unused tabs
# - Restart browser periodically

Exécution de la recherche

# Search optimization:
# - Use specific search terms
# - Enable fuzzy search carefully
# - Limit search results count
# - Use documentation-specific search
# - Cache frequently searched terms

Dépannage

Questions communes

# Documentation not loading:
# - Check internet connection
# - Clear browser cache
# - Disable browser extensions
# - Try incognito mode
# - Check DevDocs status

# Search not working:
# - Clear search cache
# - Refresh the page
# - Check enabled documentation
# - Try different search terms
# - Disable ad blockers

Questions hors ligne

# Offline problems:
# - Re-download documentation
# - Check storage quota
# - Clear offline data
# - Update browser
# - Check service worker status

# Storage management:
# - Monitor storage usage
# - Remove unused documentation
# - Clear old cache data
# - Optimize browser settings

Problèmes de performance

# Slow performance:
# - Reduce enabled documentation
# - Clear browser data
# - Close other tabs
# - Restart browser
# - Check system resources

# Memory issues:
# - Limit concurrent searches
# - Clear history regularly
# - Use fewer documentation sets
# - Restart application
# - Check available RAM

Meilleures pratiques

Gestion des documents

# Efficient setup:
# - Enable only relevant documentation
# - Group related technologies
# - Regular cleanup of unused docs
# - Keep documentation updated
# - Organize bookmarks logically

# Version management:
# - Use specific version docs when available
# - Keep legacy versions for maintenance
# - Update to latest stable versions
# - Document version dependencies

Stratégies de recherche

# Effective searching:
# - Start with broad terms, then narrow
# - Use exact method/function names
# - Include context keywords
# - Try alternative spellings
# - Use documentation-specific search

# Search organization:
# - Bookmark frequently accessed pages
# - Use browser bookmarks for quick access
# - Create custom search shortcuts
# - Organize search history

Intégration des flux de travail

# Development workflow:
# - Keep DevDocs open in dedicated tab
# - Use keyboard shortcuts for quick access
# - Integrate with IDE/editor
# - Create custom documentation sets
# - Share useful links with team

# Team collaboration:
# - Standardize documentation versions
# - Share custom configurations
# - Create team-specific bookmarks
# - Document common search patterns

Cas d'utilisation avancée

Documentation

# Custom documentation sets:
# 1. Identify team-specific needs
# 2. Create custom documentation
# 3. Host on internal servers
# 4. Configure DevDocs integration
# 5. Maintain and update regularly

# Internal API documentation:
# - Generate from code comments
# - Convert to DevDocs format
# - Host internally
# - Integrate with development workflow

Éducation Utilisation

# Learning resources:
# - Create learning paths
# - Bookmark key concepts
# - Track progress through documentation
# - Create study guides
# - Share resources with students

# Teaching integration:
# - Use in coding bootcamps
# - Reference in tutorials
# - Create assignments using DevDocs
# - Demonstrate best practices

Ressources

Documentation

[DevDocs GitHub] (LINK_10)
[Guide de calcul] (LINK_10)
[Documentation API] (LINK_10)

Communauté

[Questions relatives au GitHub] (LINK_10)
[freeCodeCamp Forum] (LINK_10)
Communauté Reddit

Solutions de remplacement

[Dash (macOS)] (LINK_10)
[Zéal (Windows/Linux)] (LINK_10)
[Vélocité (Windows)] (LINK_10)
[MDN Web Docs] (LINK_10)

DevDocs Cheat Feuille

Aperçu général

Commencer

Interface Web

Utilisation hors ligne

Gestion des documents

Fonctionnalité de la recherche

Recherche fondamentale

Recherche avancée

Conseils de recherche

Raccourcis clavier

Raccourcis de navigation

Navigation des pages

Signets et historique

Personnalisation et paramètres

Paramètres d'apparence

Configuration de la recherche

Personnalisation du clavier

Documentation populaire Ensembles

Langues de programmation

Technologies du Web

Backend et bases de données

DevOps et Cloud

Caractéristiques avancées

Documentation personnalisée

Patterns d'URL et liaison profonde

Intégration du navigateur

Auto-hébergement et déploiement

Installation locale

Déploiement Docker

Déploiement de la production

API et intégration

API URL

Automatisation du navigateur

Intégration IDE

Utilisation mobile

Application Web mobile

Application Web progressive

Optimisation des performances

Chargement des performances

Exécution de la recherche

Dépannage

Questions communes

Questions hors ligne

Problèmes de performance

Meilleures pratiques

Gestion des documents

Stratégies de recherche

Intégration des flux de travail

Cas d'utilisation avancée

Documentation

Éducation Utilisation

Ressources

Documentation

Communauté

Solutions de remplacement