Forum Discussion

Stoplight's avatar
Stoplight
Community Manager
10 months ago

Import existing API Docs From Jekyll

Originally posted by user robjmills to the Stoplight Community on 07/05/2023 at 06:44 ET.

Hey folks, we have existing API docs (non OAS based) for our legacy REST API in a Jekyll site, built with Markdown. We also have our shiny stoplight-driven docs using OAS's for all our new APIs. Is there a way to migrate the Jekyll docs into Stoplight so they're all together? It seems that Stoplight supports arbitrary Markdown files.

docs
  • Stoplight's avatar
    Stoplight
    10 months ago

    Dan T (Staff) [07/06/2023 - 17:33 ET]

    Going from a non-OAS based set of docs to Stoplight, it might be best to bite the bullet and first look at converting anything you have to OAS. With the OAS version of your API docs you will have a lot more flexibility. If you are simply looking to host the existing MD files, Stoplight can do that for you as well.

  • Stoplight's avatar
    Stoplight
    Community Manager
    10 months ago

    Dan T (Staff) [07/06/2023 - 17:33 ET]

    Going from a non-OAS based set of docs to Stoplight, it might be best to bite the bullet and first look at converting anything you have to OAS. With the OAS version of your API docs you will have a lot more flexibility. If you are simply looking to host the existing MD files, Stoplight can do that for you as well.