markright VS retype

I'm exploring something along these lines in my (now mostly dormant) project called MarkRight: https://github.com/tomashubelbauer/markright

The idea is that for didactic resources (be it documents, tutorials or even small pieces of software), your prose and code are both included in a MarkDown file and fenced code blocks are used to designate creation, altering and deletion of files. Other files that get created when "running" the MarkRight document are artifacts (the source code, the compiled executables, graphics etc.), but the document is a single source of truth. I recommend still keeping those in version control for online viewing in GitHub. I have not built anything cool with MarkRight yet, but I think the idea has potential. Curious what others think.

Outside of Swift, I use RetypeApp and they have a lot of inbuilt functionality. You can then generate your output directory on build, and use those HTML files as is.

You can build pretty beautiful docs with: - https://retype.com - https://docusaurus.io - https://www.intercom.com/articles

Retype is the nicest one I’ve come across in my search! Has a built in table of contents, pretty easy to create (entirely using markdown) and great support for emojis, math, containers, multi tab info panels, and proper dropdown panels.

Are you aiming at creating something like this? With a bar on the left with folders?

I recently set up something with https://retype.com/ and it's quite good.

While gitbook does wrap the branching/merging process in a UI that is digestible by non-developers, Retype is far more powerful because you actually use GitHub (or GitLab). You have the full power of GitHub, including branching, pull-requests, issues, reviews, automation, authentication, and everything else.

For example, here's the repo for the retype.com website, see https://github.com/retypeapp/retype

The entire website is built from simple Markdown text files.