Confluence Site Converter

Overview

Features

• Content Retrieval from Confluence

• HTML Conversion

• Metadata generation for Jekyll

• (We may consider publishing the source code and Actions?)

Resources

• https://ocaml.org/learn/tutorials/guidelines.html

• https://wiki.xenproject.org/wiki/OCaml_Best_Practices_for_Developers

• https://github.com/ocaml-community/awesome-ocaml

• Confluence API

  • https://developer.atlassian.com/cloud/confluence/rest/api-group-content/#api-wiki-rest-api-content-id-get

Source Code

• https://github.com/haruki-sugarsun/confluenece_site_converter

Technical Stack

OCaml

• OCaml

• OPAM

• TODO: dune

Used Libraries

• HTML manipulation http://aantron.github.io/lambdasoup/

• JSON processing Yojson https://github.com/ocaml-community/yojson

  • https://ocaml-community.github.io/yojson/yojson/Yojson/index.html

  • https://mjambon.github.io/mjambon2016/yojson-doc/Yojson.html

• HTTP Client ocaml-cohttp https://github.com/mirage/ocaml-cohttp

  • https://mirage.github.io/ocaml-cohttp/

• Command-Line Parsing

  • ocaml-getopt http://alain.frisch.fr/soft.html#Getopt

    • ?

  • or Core's Command https://github.com/janestreet/core

    • https://ocaml.janestreet.com/ocaml-core/latest/doc/core/Core/Command/

      • https://github.com/janestreet/core/blob/v0.14/src/core_command.mli is the one available in opam.(latest stable?)

      • https://www.brendanlong.com/how-to-use-corecommandparam.html

    • https://dev.realworldocaml.org/command-line-parsing.html

    • → Learned that Core overrides the standard lib namespace. https://ocaml.janestreet.com/ocaml-core/109.55.00/tmp/core_kernel/Core_list.html interesting~

      • https://discuss.ocaml.org/t/what-is-the-preferable-solution-for-the-role-of-standard-library/1092

    • Random investigation note:

      • > ls -a cmd.ml | entr ocamlfind ocamlopt -package core,ppx_let,ppx_jane,async,core.top,core_kernel cmd.ml

    • command-line param http://ocaml.jp/?Arg

• TODO: Logging

  • https://github.com/codinuum/volt

• TODO: https://opam.ocaml.org/packages/sqlite3/

  • maybe just storing as JSON is enough? :p

For Jekyll

TODO: better page structure

• https://mmistakes.github.io/minimal-mistakes/docs/stylesheets/

References