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

Create Jekyll template for doc site #28

Closed
crandmck opened this issue Jul 11, 2016 · 3 comments
Closed

Create Jekyll template for doc site #28

crandmck opened this issue Jul 11, 2016 · 3 comments

Comments

@crandmck
Copy link
Contributor

crandmck commented Jul 11, 2016

We need a JavaScript widget that essentially duplicates the navigation panel on http://docs.strongloop.com. The source of the nav content will be nested lists in markdown and the result at runtime should be a nice "expandable" navigation widget.

This is part of Proposal to make LoopBack documentation open source.

@superkhau
Copy link
Contributor

Big thumbs up! 👏

@crandmck
Copy link
Contributor Author

crandmck commented Jul 12, 2016

I found an excellent Jekyll theme that we should be able to leverage: http://idratherbewriting.com/documentation-theme-jekyll/ (source in https://github.com/tomjohnson1492/documentation-theme-jekyll). This has almost everything we need and is MIT-licensed.

Also, for comparison, this is very close to what we're looking for: http://hamishwillee.github.io/jekyll-bootstrap-docsite/ (source in https://github.com/hamishwillee/jekyll-bootstrap-docsite).

@crandmck crandmck changed the title Create dynamic navigation widget Create Jekyll template for doc site Jul 25, 2016
@crandmck
Copy link
Contributor Author

I'm going to close this, since we've chosen the documentation-theme-jekyll template and largely implemented it in http://loopback.io/doc/.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants