Appwrite Markdown SDK

This SDK is compatible with Appwrite server version 1.8.x. For older versions, please check previous releases.

Appwrite is an open-source backend as a service server that abstracts and simplifies complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Markdown SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to https://appwrite.io/docs

This SDK provides programmatic access to Appwrite documentation, designed for AI consumption with lazy-loading and search capabilities.

Installation

npm install @appwrite.io/docs

Usage

Get Table of Contents

Retrieve a lightweight table of contents without loading document content:

import { getTableOfContents } from '@appwrite.io/docs';

const toc = getTableOfContents('typescript');
// → { language: 'typescript', services: [{ name: 'account', methods: [...] }] }

Get Specific Documentation

Load a specific markdown document by path:

import { getMarkdown } from '@appwrite.io/docs';

const doc = await getMarkdown('typescript', 'account/create-session');
// → '# createSession\n\nDescription: ...'

Search Documentation

Search across all documents by keywords:

import { searchDocs } from '@appwrite.io/docs';

const results = await searchDocs('typescript', 'MFA authentication', { limit: 5 });
// → [{ path: 'account/create-mfa-...', title: '...', snippet: '...' }]

Using the SDK Class

For more control, instantiate the SDK class directly:

import { DocsSDK } from '@appwrite.io/docs';

const sdk = new DocsSDK();

// Get all available languages
const languages = sdk.getLanguages();

// Load all docs for a service
const accountDocs = await sdk.getServiceDocs('typescript', 'account');

// Clear cache to free memory
sdk.clearCache();

API Reference

Functions

Function	Description
getLanguages()	Get list of available SDK languages
getTableOfContents(language)	Get TOC for a language (lightweight, no content)
getMarkdown(language, path)	Get specific markdown document
searchDocs(language, query, options?)	Search documentation by keywords

DocsSDK Class

Method	Description
getLanguages()	Get list of available SDK languages
getTableOfContents(language)	Get TOC for a language
getMarkdown(language, path)	Get specific markdown document (cached)
getServiceDocs(language, service)	Get all docs for a service
searchDocs(language, query, options?)	Search documentation
clearCache()	Clear the content cache
getCacheStats()	Get cache statistics

Search Options

Option	Type	Default	Description
limit	number	10	Maximum results to return
minScore	number	0.1	Minimum relevance score (0-1)
services	string[]	all	Filter to specific services

Building from Source

# Install dependencies
npm install

# Generate manifest from markdown files
npm run build:manifest

# Compile TypeScript
npm run build

Contribution

This library is auto-generated by the custom SDK Generator. To learn more about how you can help us improve this SDK, please check the contribution guide before sending a pull-request.

License

Please see the BSD-3-Clause license file for more information.