mirror of
https://github.com/testthedocs/awesome-docs.git
synced 2026-07-20 07:54:11 -05:00
sven
458651601e
- Added local search provider configuration - Enhanced search with custom translations and options - Created API reference page with searchable content - Updated navigation to include API section - Added Reference section to sidebar - Search now indexes all documentation content
81 lines
1.5 KiB
Markdown
81 lines
1.5 KiB
Markdown
# API Reference
|
|
|
|
This page contains the API reference for our documentation system.
|
|
|
|
## Configuration
|
|
|
|
### Basic Configuration
|
|
|
|
The basic configuration includes:
|
|
|
|
- **Title**: Set the main title of your documentation
|
|
- **Description**: Provide a brief description
|
|
- **Theme**: Configure the appearance and behavior
|
|
|
|
### Advanced Configuration
|
|
|
|
For advanced users, you can customize:
|
|
|
|
- **Navigation**: Custom navigation menus
|
|
- **Sidebar**: Dynamic sidebar generation
|
|
- **Search**: Local search configuration
|
|
- **Plugins**: Additional functionality
|
|
|
|
## Methods
|
|
|
|
### `configure(options)`
|
|
|
|
Configure the documentation system with the provided options.
|
|
|
|
**Parameters:**
|
|
- `options` (Object): Configuration options
|
|
- `title` (String): Documentation title
|
|
- `description` (String): Site description
|
|
- `theme` (Object): Theme configuration
|
|
|
|
**Example:**
|
|
```javascript
|
|
configure({
|
|
title: 'My Docs',
|
|
description: 'Comprehensive documentation',
|
|
theme: {
|
|
nav: [...],
|
|
sidebar: [...]
|
|
}
|
|
})
|
|
```
|
|
|
|
### `search(query)`
|
|
|
|
Perform a search across all documentation content.
|
|
|
|
**Parameters:**
|
|
- `query` (String): Search query string
|
|
|
|
**Returns:**
|
|
- Array of search results with matches
|
|
|
|
## Examples
|
|
|
|
Here are some common usage examples:
|
|
|
|
### Setting up Navigation
|
|
|
|
```javascript
|
|
nav: [
|
|
{ text: 'Home', link: '/' },
|
|
{ text: 'Guide', link: '/guide' },
|
|
{ text: 'API', link: '/api' }
|
|
]
|
|
```
|
|
|
|
### Configuring Search
|
|
|
|
```javascript
|
|
search: {
|
|
provider: 'local',
|
|
options: {
|
|
// Search configuration
|
|
}
|
|
}
|
|
``` |