If we would like to use GitHub Pages for it, we can use:

mdoc - that can process markdown files into markdown files, benefits:
- it has ability to compile sample code scala
- checks internal links
- it support some kind of variables (e.g. we can "inject" value of current version of the library)
for creating site from markdown (either "raw" one or output from mdoc) we can use:
- jekyll
  - default mechanism of GitHub Pages, pretty old, but looks mature
- docusaurus
  - downside: for what is see it has only option to creates website on a separate branch (gh-pages)
  - upside: mdoc suggested library
  - upside: modern stack

Probably we will need to move documentation from the README.md in the root directory into some structure of files. Current README can contain some overal description with list of features - which will link to the documentation on the GitHub pages.

I would suggest to try mdoc and jekyll and see how it looks. We can create fork of the repo and experiment there to not litter main repo, what do you think?

Improve docs #13

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions