API documentation template a la Slate

[jaredmoody]

At work we currently use Slate to generate our API documentation. Slate is based on middleman, but IIRC are looking to remove ruby and move to a node-only implementation.

Generating static API docs seems right in Bridgetown's wheelhouse - does anyone know of an existing project using Bridgetown that's similar to Slate, or might someone be interested in collaborating to create one?

[jaredcwhite]

@jaredmoody While you certainly can use Bridgetown for documentation, it's not especially suited to the sort of really in-depth docs you need for APIs. I'd certainly be interested in collaborating on a trial run of it though!

[jaredmoody]

Is there some reason Bridgetown is less suited toward API docs than middleman, which Slate uses?

[jaredcwhite]

No, not that I know of. I'm sure it can be done…just a matter of who has the time or inclination to give building that extra layer a try.

[matoni109]

@jaredcwhite I'm looking at trying to do this with spectaql for our graphql docs.

This library generates the docs into a folder with below structure via a yarn script.

• what wold be the best way to integrate the below html / css / js / into the bridgetown build ?

  -- build
    -- images
      -- logo.svg
    -- javascripts
      -- spectaql.js
    -- stylesheets
      -- spectraql.css
    index.html

Would you be interested in exploring this ?