This repository contains a set of packages for interacting with the HackMD API.
See README
To help you get started quickly, we provide comprehensive usage examples in the examples/
directory:
The examples/nodejs/
directory contains a complete example project demonstrating:
- User information retrieval
- Note creation and management
- ETag support for caching
- Content updates
- Error handling with retry logic
- Environment variable configuration
To run the Node.js example:
- Navigate to the example directory:
cd examples/nodejs
- Follow the setup instructions in examples/nodejs/README.md
- Set your HackMD access token
- Run
npm start
The example includes detailed comments and demonstrates best practices for using the HackMD API client.
The examples/book-mode-conference/
directory contains a TypeScript example for creating a "book mode" conference note system:
- Book Mode Notes: Creates a master note that links to all session notes
- Bulk Note Creation: Automatically creates individual notes for each conference session
- TypeScript Implementation: Full type safety with tsx support for direct execution
- Configurable Templates: Customizable note templates and conference settings
- Hierarchical Organization: Sessions organized by day and time in the main book
- Error Handling: Graceful handling of API failures during bulk operations
To run the book mode conference example:
- Navigate to the example directory:
cd examples/book-mode-conference
- Follow the setup instructions in examples/book-mode-conference/README.md
- Customize the configuration constants and session data
- Set your HackMD access token
- Run
npm start
This example demonstrates advanced usage patterns including bulk operations, team note management, and creating interconnected note structures for conferences or events.
MIT