1.4 KiB
Executable File
| title | tags | keywords | last_updated | summary | sidebar | permalink | folder | |
|---|---|---|---|---|---|---|---|---|
| Special layouts overview |
|
layouts, information design, presentation | July 3, 2016 | This theme has a few special layouts. Special layouts include the JS files they need directly in the page. The JavaScript for each special layout does not load by default for every page in the site. | mydoc_sidebar | mydoc_special_layouts.html | mydoc |
{% include note.html content="By "layout," I'm not referring to the layouts in _layouts in the project files. I'm referring to special ways of presenting information on the same "page" layout." %}
FAQ layout
See {{site.data.mydoc_urls.mydoc_faq.link}} for an example of the FAQ format, which follows an accordion, collapse/expand format. This code is from Bootstrap.
Knowledgebase layout
See {{site.data.mydoc_urls.mydoc_kb_layout.link}} for a possible layout for knowledge base articles. This layout looks for pages containing specific tags.
Scroll layout
If you have a long JSON message you're documenting, see the {{site.data.mydoc_urls.mydoc_scroll.link}}. This layout adds a side pane showing links to pointers in the left pane.
Shuffle layout
If you want a dynamic card layout that allows you to filter the cards, see {{site.data.mydoc_urls.mydoc_shuffle.link}}. This uses the Shuffle JS library.
{% include links.html %}