Document question body syntax #211
Conversation
docs/common/header.md
Outdated
| <li><a href="{{baseUrl}}/userGuide/includingContents.html">Including Contents</a></li> | ||
| <li><a href="{{baseUrl}}/userGuide/siteConfiguration.html">Site Configuration</a></li> | ||
| <li><a href="{{baseUrl}}/userGuide/netlifyPreview.html">Preview site on Netlify</a></li> | ||
| <li><a href="{{baseUrl}}/userGuide/includingContents.html">Content Authoring — Including Contents</a></li> |
There was a problem hiding this comment.
This way, it looks like a sub-menu item.
Content Authoring — Including Contents -> — Including Contents?
docs/common/header.md
Outdated
| <li><a href="{{baseUrl}}/userGuide/siteConfiguration.html">Site Configuration</a></li> | ||
| <li><a href="{{baseUrl}}/userGuide/netlifyPreview.html">Preview site on Netlify</a></li> | ||
| <li><a href="{{baseUrl}}/userGuide/includingContents.html">Content Authoring — Including Contents</a></li> | ||
| <li><a href="{{baseUrl}}/userGuide/contentAuthoringExamples.html">Content Authoring — Examples</a></li> |
There was a problem hiding this comment.
It's better to mix examples together with the descriptions?
|
|
||
| <div slot="hint"> | ||
| Probably yes | ||
| </div> |
There was a problem hiding this comment.
If we add a blank line here, would it add some separation between hint and answer? It doesn't look nice when the two are stuck together.
There was a problem hiding this comment.
Nope, because of the way Vue components work. I can do some styling in Question component.
docs/site.json
Outdated
| "src": "userGuide/siteConfiguration.md", | ||
| "title": "MarkBind: User Guide - Site Configuration" | ||
| "src": "userGuide/ghpagesDeployment.md", | ||
| "title": "MarkBind: User Guide - Github Pages Deploment" |
|
|
||
| ## Question body syntax | ||
|
|
||
| MarkBind allows for the easy use of checkboxes and radio buttons with the Question and Panel components in [VueStrap modified by MarkBind](https://markbind.github.io/vue-strap/). |
There was a problem hiding this comment.
"MarkBind allows for the easy use of using checkboxes and radio buttons with..."
Used white bullet (◦) and added separators.
Tried to support sub-menu items (#212) but couldn't handle hover elegantly:
|
|
Moved the example to contentauthoring#use-components. |
| <br><br> | ||
|
|
||
| ```html | ||
| <panel header=":lock::key: Does MarkBind allow for the use of checkboxes and radio buttons?"> |
There was a problem hiding this comment.
Is it a good idea to put the sample source code inside the answer slot? They might miss it if they do not expand the answer slot.
acjh
force-pushed
the
84-document-question-body-syntax
branch
from
8464109 to
32a1910
Compare
3 participants
What is the purpose of this pull request? (put "X" next to an item, remove the rest)
• [x] Documentation update
Resolves #84
Resolves #216
What is the rationale for this request?
Provide an example for usage of checkboxes and radio buttons with Question component.
What changes did you make? (Give an overview)
Provide some example code that this change will affect:
-
Is there anything you'd like reviewers to focus on?
Phrasing, grammar and verbosity.
Testing instructions:
Check that the example and the links (navbar, sections) on the Netlify preview work as expected.