コンテンツにスキップ
1337skills 1337skills - チートシート

DevDocsチートシート

## 概要

DevDocsは、複数の開発者向けリファレンスを1つの検索可能なインターフェースに統合する、高速でオフライン対応のAPIドキュメントブラウザです。何百もの プログラミング言語、フレームワーク、ツールのドキュメントに強力な検索機能とオフライン機能で即座にアクセスできます。

⚠️ 注意: devdocs.ioで無料で利用可能。オープンソースで自己ホスト可能。

はじめに

Webインターフェース

オフライン利用

デスクトップアプリ

ナビゲーションとインターフェース

メインインターフェース

ドキュメント管理

検索機能

基本検索

高度な検索

検索のヒント

キーボードショートカット

ナビゲーションショートカット

ページナビゲーション

ブックマークと履歴

カスタマイズと設定

外観設定

検索設定

キーボードカスタマイズ

人気のドキュメントセット

プログラミング言語

Web技術

バックエンドとデータベース

DevOpsとクラウド

高度な機能

カスタムドキュメント

Would you like me to fill in more specific details for each section, or is this general translation structure what you were looking for?```bash

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


### Offline Usage
```bash
# 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

Desktop Apps

# 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

Main Interface

# 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

Documentation Management

# 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

Search Functionality

# 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
# 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

Search Tips

# 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

Keyboard Shortcuts

# 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

Page Navigation

# 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

Bookmarks and History

# 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

Customization and Settings

Appearance Settings

# 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

Search Configuration

# 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

Keyboard Customization

# 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

Programming Languages

# 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

Web Technologies

# 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 and Databases

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

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

DevOps and 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

Advanced Features

Custom Documentation

# 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
```Translate just the section headers```bash
# 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
```Wait for you to provide the text content to translate```bash
# 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
```Generate sample placeholder text in Japanese for these sections

Which approach would you prefer?```bash
# 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

Docker Deployment

# 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

Production Deployment

# 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 and Integration

URL API

# 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

Browser Automation

// 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;
}

IDE Integration

# 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

Mobile Usage

Mobile Web App

# 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)

Progressive Web App

# 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

Performance Optimization

Loading Performance

# 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

Search Performance

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

Troubleshooting

Common Issues

# 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

Offline Issues

# 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

Performance Issues

# 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

Best Practices

Documentation Management

# 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

Search Strategies

# 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

Workflow Integration

# 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

Advanced Use Cases

Documentation Curation

# 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

Educational Use

# 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
```## リソース
https://github.com/freeCodeCamp/devdocs##

# ドキュメンテーション
- [DevDocs GitHub](
https://github.com/freeCodeCamp/devdocs/blob/main/CONTRIBUTING.md)
- [コントリビューションガイド](
https://devdocs.io/about)
- [API ドキュメンテーション](
https://github.com/freeCodeCamp/devdocs/issues)
https://forum.freecodecamp.org/##

# コミュニティ
- [GitHub Issues](
https://www.reddit.com/r/devdocs/)
- [freeCodeCamp フォーラム](
https://kapeli.com/dash)
- [Reddit コミュニティ](
https://zealdocs.org/)
https://velocity.silverlakesoftware.com/##

# 代替ツール
- [Dash (macOS)](
https://developer.mozilla.org/)
- [Zeal (Windows/Linux)](