Misc doc updates#1294
Conversation
damithc
left a comment
damithc
left a comment
There was a problem hiding this comment.
Good work. Added a few comments.
| </include> | ||
| </div> | ||
|
|
||
| <modal header="Richer formatting of attributes using slots" id="on-slots"> |
There was a problem hiding this comment.
👀 never knew this existed, it's undocumented as well. added a commit to document this too
| --- {.border-danger} | ||
|
|
||
| Apply the same to inline markdown (eg. bold text) by | ||
| omitting the **space**{.text-primary .bg-light attribute=value} |
There was a problem hiding this comment.
html attributes don't require the "quotes" if there aren't any spaces in the value
There was a problem hiding this comment.
I didn't mean the quotes. That whole thing shouldn't be there, right?
There was a problem hiding this comment.
it's to show an example of attributes (vs classes and ids), but since these aren't visual, you'd have to use inspect element to see it.
There was a problem hiding this comment.
Can use a real or real-looking attribute name and a value instead? Otherwise it looks like a generic placeholder.
There was a problem hiding this comment.
added a comment to use inspect element
| Apply the same to inline markdown (eg. bold text) by | ||
| omitting the **space**{.text-primary .bg-light attribute=value} | ||
| </variable> | ||
| </include> |
There was a problem hiding this comment.
Side question: what if I want to apply a style to multiple words inside a paragraph that doesn't have any markdown symbol around them? No shorthand syntax for that I guess.
There was a problem hiding this comment.
yep don't think there's any shorthand for that unfortunately
| * [Setting up]({{baseUrl}}/devGuide/settingUp.html) | ||
| * [Workflow]({{baseUrl}}/devGuide/workflow.html) | ||
| * [Design]({{baseUrl}}/devGuide/design.html) | ||
| * [Writing Plugins]({{baseUrl}}/devGuide/writingPlugins.html) |
There was a problem hiding this comment.
Writing plugins is not just for devs. Even regular users are supposedly can write plugins. Give at least a link from the UG as well.
There was a problem hiding this comment.
Added. I think the main content should stay in the devguide though, since the large majority of users won't be writing such plugins.
- Add section on markdown attributes (attributes.mbdf) - Fix a minor spelling error in formattingContents.md - Add missing newline at eof (images.mbdf, tables.mbdf) - Add relative link example using markdown (links.mbdf) - Add starting list number trick example (lists.mbdf)
ang-zeyu
force-pushed
the
misc-doc-updates
branch
from
cc64582 to
d46e80d
Compare
|
also: Resolves #567 |
2 participants
What is the purpose of this pull request? (put "X" next to an item, remove the rest)
• [x] Documentation update
What is the rationale for this request?
Resolve a couple more documentation issues before release
What changes did you make? (Give an overview)
810244d
#1274 (comment)
ac13f89
Resolves #1106 - review would be nice here, not sure if it's confusing @damithc
Should resolve #339 as well -
<md>tags are already documentedResolves #888
Resolves #1276
06e1907
Resolves #1258
2377dd4
Resolves #1151 - not too sure where to put this in the site nav, looks a little out of place 🤔
ae7a0bb
Resolves #611
3c5b75b
Resolves #1230
50c92a1
Resolves #993
Proposed commit message: (wrap lines at 72 characters)
Let's do a rebase merge here