Skip to content

josbeir/cakephp-docs-md

Repository files navigation

CakePHP Markdown docs

This is a proof of concept project for converting CakePHP's RST documentation format to Markdown.

Overview

This project demonstrates the feasibility of migrating CakePHP's documentation from reStructuredText (RST) / Sphinx to Markdown format, making it more accessible and easier to work with modern documentation tools.

Progress

The converted markdown files have been integrated into a VitePress site for demonstration purposes. You can view the result here:

CakePHP (new) book

Conversion Script

The main conversion is happening with pandoc with a bunch of added filters to make Sphinx conversion work.

Note: a large part of the conversion script was carefully prompted and generated by AI.

Purpose

  • Evaluate the conversion process from RST to Markdown
  • Test compatibility with modern static site generators
  • Explore improved documentation workflows and tooling

About

An effort to convert CakePHP's rst docs to markdown

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •