Cloudflare MDX

Introduction

Welcome to cloudflare-mdx – a dynamic content rendering project designed for deployment on Cloudflare Workers. This project serves as a specialized hub for viewing and managing personal records and notes with a focus on simplicity and performance.

Github Repo

Features

Cloudflare Worker Deployment: Engineered to operate seamlessly within the Cloudflare ecosystem, leveraging the global reach and efficiency of Workers.
Daily Records Viewing: Tailored specifically for accessing daily logs and notes, providing a streamlined user experience.
Markdown Rendering: Utilizes marked in combination with highlight.js to transform Markdown into beautifully formatted HTML, offering an enhanced reading experience.
Future MDX Support: While currently focused on Markdown, plans are in place to expand functionality to include MDX, enabling richer content composition.
Companion Page: Features a twin page that utilizes mdx-editor for rendering, thereby creating a cohesive content creation and viewing environment.

Upcoming Features (Checklist)

Markdown Composition: Capability to compose content from multiple Markdown sources.
[🐙] Table of Contents (TOC): Automatically generated, interactive TOC for swift navigation within documents, complete with jump-to-section functionality.
Collapsible Code Blocks: Adding the ability to collapse and expand code blocks in the rendered output, facilitating a cleaner and more focused reading space.

Deployment

The cloudflare-mdx project is designed for ease of deployment to a Cloudflare Worker. Follow the standard Cloudflare Workers deployment procedures to get started.

Usage

Simply filter your daily logs or notes by tags/title/ids... in Markdown format to the Worker, and let cloudflare-mdx handle the rendering. Navigate your compiled logs with ease, benefitting from syntax-highlighted code and a clear, distraction-free interface.

<host>/<id>