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

Headings to the left in Docs layout #10

Open
dfahlander opened this issue Feb 10, 2017 · 1 comment
Open

Headings to the left in Docs layout #10

dfahlander opened this issue Feb 10, 2017 · 1 comment

Comments

@dfahlander
Copy link
Collaborator

I think we should use a layout with improved overview for dexie docs. It seems quite common to have a left navigation div with headers like get started API reference etc and put in the content to the right.

Simple layout

React layout (more advanced, but still clean):

I hope to fix this as soon as I have the time, unless anyone else feels eager to do it.

@nponiros
Copy link
Collaborator

Yes I also suggested something similar in #3 regarding the splitting of the docs into API, Tutorial etc. To do this in jekyll we will probably have to define categories for each page so that we can filter based on the category when creating the sidebar. Maybe there is also a way to get the full path and filter based on subdirectory. So if the path contains "API" we don't show the page in the sidebar but add it to the API page.

We will probably also need different layouts so that we can show all API docs in the API page sidebar, all Tutorial docs in a Tutorial page sidebar etc.

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