How to turn a folder of markdown docs into a structured docs section in an app?

This page summarizes the projects mentioned and recommended in the original post on /r/iOSProgramming

Our great sponsors
  • InfluxDB - Power Real-Time Data Analytics at Scale
  • WorkOS - The modern identity platform for B2B SaaS
  • SaaSHub - Software Alternatives and Reviews
  • Publish

    A static site generator for Swift developers

  • First thing I thought of was John Sundell's Publish, then make all the articles as posts. A bit of HTML work and have it list it as a sidebar with an order metadata of the markdown. You could then use the LocalWebsitePublishPlugin to make it all accessible offline too - though I haven't tested it so I dont know if it works or not. There are not a lot, but some plugins available too that are helpful, and it's nice to be inside of the same language ecosystem.

  • retype

    Retype is an ✨ ultra-high-performance✨ static site generator that builds a website based on simple text files.

  • 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.

  • InfluxDB

    Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

    InfluxDB logo
  • LocalWebsitePublishPlugin

    A local website plugin for the Publish static site generator

  • First thing I thought of was John Sundell's Publish, then make all the articles as posts. A bit of HTML work and have it list it as a sidebar with an order metadata of the markdown. You could then use the LocalWebsitePublishPlugin to make it all accessible offline too - though I haven't tested it so I dont know if it works or not. There are not a lot, but some plugins available too that are helpful, and it's nice to be inside of the same language ecosystem.

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts