withDogecoin / chaterview

AI-based(e.g ChatGPT) Developer interview practice service
0 stars 1 forks source link

Configuration MkDocs #10

Closed BAEKJungHo closed 1 year ago

BAEKJungHo commented 1 year ago

Discussed in https://github.com/withDogecoin/chaterview/discussions/11

Originally posted by **BAEKJungHo** April 21, 2023 # Solutions 1. __Asciidoctor + Spring REST Docs__ - https://asciidoctor.org/ - https://spring.io/guides/gs/testing-restdocs/ 2. __OpenAPISpec__ - https://swagger.io/specification/ - [OpenApiSpec.을 이용한 더욱 효과적인 API 문서화 with Kotlin](https://github.com/traeper/api_documentation) 3. __OpenAPISpec + RestDocs + MkDocs__ - https://www.mkdocs.org/ - https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes 4. __Orchid - How to Document a Kotlin Project__ - https://orchid.run/wiki/learn/tutorials/how-to-document-kotlin
BAEKJungHo commented 1 year ago

Publish Docs with Github Pages