Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include real code samples in documentation #36

Closed
robfletcher opened this issue May 21, 2018 · 4 comments
Closed

Include real code samples in documentation #36

robfletcher opened this issue May 21, 2018 · 4 comments
Assignees
Labels
🙄 chore Infrastructure or build related 📖 documentation Documentation required

Comments

@robfletcher
Copy link
Owner

Too much chance of error. I don't think mkdocs supports it though so may have to pre-process or use something else.

@robfletcher robfletcher added 📖 documentation Documentation required 🙄 chore Infrastructure or build related labels May 21, 2018
@robfletcher robfletcher self-assigned this May 22, 2018
@robfletcher
Copy link
Owner Author

Possible to use/adapt this? https://github.com/Kotlin/kotlinx.coroutines/tree/master/knit

@cjbrooks12
Copy link
Contributor

cjbrooks12 commented Sep 22, 2018

Orchid now natively supports Kotlin code docs, and using Orchid would open up a world of possibilities like real code samples and versioned Github Pages deploys, if you'd want to switch away from JBake. You can see an example site with Kotlin docs here. I'd be willing to get this set up, converting the current theme and content to Orchid.

@robfletcher
Copy link
Owner Author

Sounds great. I would be 100% open to moving to Orchid. I did try it out a few months back but got stuck trying to get the API docs published along with the site (can't remember the specific issue now).

@robfletcher
Copy link
Owner Author

Fixed by migration to Orchid

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🙄 chore Infrastructure or build related 📖 documentation Documentation required
Projects
None yet
Development

No branches or pull requests

2 participants