Oxarlly

Oxarlly is a tool that helps you easily generate a wiki website from markdown files. It comes with built-in search functionality using Lunr.js and a simple Express.js server to serve your generated HTML files.

Features

• Convert markdown files to HTML.
• Built-in search with Lunr.js.
• Simple Express.js server to serve your wiki.

Installation

To install Oxarlly, you need to have Node.js and npm installed.

1. Clone the repository or install via npm:

   npm install oxarlly```

2. Add markdown files to your project (e.g., in a docs/ directory).

3. In your index.js or app entry point, use Oxarlly like this:

const oxarlly = require('oxarlly');

// Convert markdown files to HTML
oxarlly.convert('./docs/file1.md');

// Start the Express server
oxarlly.server.start();

4. Open your browser and go to http://localhost:3000 to view your wiki.