mbarbin/doc-experiment-docusaurus
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Experimenting with docusaurus+odoc
55 commits 1 branch 0 tags 1 MiB
  • OCaml 64.9%
  • Dune 25.5%
  • Makefile 9.6%
Find a file
Exact
Mathieu Barbin 435f8f55ae
 Merge pull request #14 from mbarbin/use-mdexp 
Use mdexp
2026-03-28 15:33:22 +01:00
.github/workflows Setup mdexp in ci 2026-03-28 15:00:21 +01:00
.vscode Init 2024-07-21 11:23:10 +02:00
doc Use mdexp 2026-03-28 15:05:38 +01:00
src Update dependencies 2026-03-28 15:06:18 +01:00
test Update dependencies 2026-03-28 15:06:18 +01:00
third-party-license Migrate CI to setup-dune 2026-03-12 09:53:01 +01:00
.gitattributes Init 2024-07-21 11:23:10 +02:00
.gitignore Ignore local coverage script 2026-03-28 15:00:31 +01:00
.ocamlformat Update dependencies 2026-03-28 15:06:18 +01:00
CHANGES.md Init 2024-07-21 11:23:10 +02:00
doc-experiment-docusaurus-dev.opam Add sherlodoc again 2026-03-28 15:19:33 +01:00
doc-experiment-docusaurus-tests.opam Add dev and test packages 2026-03-11 21:04:07 +01:00
dune Init 2024-07-21 11:23:10 +02:00
dune-project Add sherlodoc again 2026-03-28 15:19:33 +01:00
dune-workspace-5.4 Add alpha repo (bisect_ppx & 5.4) 2026-03-28 15:10:14 +01:00
dunolint Update dunolint config 2026-03-28 15:06:27 +01:00
LICENSE Init 2024-07-21 11:23:10 +02:00
Makefile Init 2024-07-21 11:23:10 +02:00
mylib.opam Add dev and test packages 2026-03-11 21:04:07 +01:00
myotherlib.opam Update dependencies 2026-03-28 15:06:18 +01:00
README.md Update README 2026-03-28 15:20:56 +01:00

README.md

doc-experiment-docusaurus

CI Status

Logo

Welcome to this experiment with documentation tools! In this project, we're exploring how Docusaurus can be used to document OCaml projects, while seamlessly integrating with OCaml's dedicated tools like dune, odoc, etc.

Status

🚧 This repo is currently experimental and under construction. It's a work in progress.

Acknowledgements

The essence of the doc-experiment project lies in creating a setup where each tool plays a crucial role, contributing to a seamless documentation experience for OCaml projects. The real magic, however, resides in the hard work, dedication, and innovation embedded within each of these tools. We are immensely thankful for the amazing features these tools offer and even more so to the myriad of contributors behind them.

We extend our deepest gratitude to the following projects and their contributors:

  • ocaml: For the OCaml programming language, which is at the heart of our documentation journey.
  • dune: For the Dune build system, enabling us to compile our OCaml projects with ease.
  • setup-dune: For seting up OCaml environments in our CI workflows.
  • setup-ocaml: Another OCaml CI tool we also used to work on the repo.
  • odoc: For the odoc tool, which generates styled HTML documentation from OCaml packages.
  • mdexp: For authoring markdown files including compiled OCaml code fragment and generated contents, ensuring our documentation is always up to date.
  • sherlodoc: For its innovative approach to searching OCaml documentation.
  • docusaurus: For providing a platform to bring all our documentation together in a user-friendly and accessible manner.

In addition to this, we also want to acknowledge the broader community and various other resources that are supporting us in more open-ended ways. Their contributions, though not always directly linked to the core functionality of our project, have significantly enriched our journey and the overall project outcome.

  • OpenArt AI: With which we generated the logo for our project.

The collective effort of all these tools, resources, and their communities has been instrumental in bringing the doc-experiment project to life. We are grateful for their existence and the communities that support them.