BeDoc

BeDoc is a powerful, pluggable documentation generator designed to handle any programming language and output format. With its extensible framework, you can easily create custom parsers and formatters to generate structured documentation for your projects.

Key Features

• Pluggable Design: BeDoc works seamlessly with custom parsers and formatters to fit your unique needs. BeDoc also supports async operations, allowing for efficient handling of large projects.
• Customizable Input: Accommodate any text input, whether it’s a well-known language like LPC or Lua, or an underserved format needing attention.
• Async Hooks: Take advantage of BeDoc's powerful ability to use async hooks to modify content in-flight, providing dynamic customization during the documentation generation process.
• Versatile Output: Generate documentation in formats like Markdown, Wikitext, and more.
• Configurable: Supports JSON-based configuration for seamless customization.
• Integrated Workflow: Use the CLI for smooth integration into your development environment.

Installation

Install BeDoc globally using NPM:

npm i -g @gesslar/bedoc

Or add it to your project as a dev dependency:

npm i -D @gesslar/bedoc

Quick Start

Here’s how to use BeDoc programmatically:

import BeDoc from "@gesslar/bedoc"

// Initialize BeDoc with your configuration
const docGenerator = new BeDoc({
  input: './src',
  output: './docs',
  format: 'markdown',
});

// Generate documentation
(async () => {
  try {
    await docGenerator.generate();
    console.log('Documentation generated successfully!');
  } catch (error) {
    console.error('Error generating documentation:', error);
  }
})();

For detailed usage instructions and examples, visit the website: 👉 BeDoc Documentation

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.

License

@gesslar/bedoc is released into the public domain under the Unlicense.

This package includes or depends on third-party components under their own licenses:

| Dependency | License | | --- | --- | | @gesslar/actioneer | 0BSD | | @gesslar/colours | 0BSD | | @gesslar/negotiator | 0BSD | | @gesslar/toolkit | 0BSD | | commander | MIT | | error-stack-parser | MIT |

Get started with BeDoc today and simplify your documentation workflow!

Do not taunt Happy Fun Ball.