Update MarkBind documentation to use layouts#858
Conversation
| <header> | ||
| <link rel="stylesheet" href="{{baseUrl}}/css/main.css"> | ||
| <navbar type="dark"> | ||
| <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20" /></a> |
There was a problem hiding this comment.
Minor nit: remove the backlash in img to be in line with the other img tags
| <header> | ||
| <link rel="stylesheet" href="{{baseUrl}}/css/main.css"> | ||
| <navbar type="dark"> | ||
| <a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20" /></a> |
There was a problem hiding this comment.
Minor nit: remove the backlash in img to be in line with the other img tags
As img tags are void elements in HTML, the / character has no effect on it. Let's remove it to clean up our documentation.
yamgent
left a comment
yamgent
left a comment
There was a problem hiding this comment.
Will header.md, footer.md, userGuideSections.md and devGuideSections.md be used after this PR is merged? If not, can consider removing it...
Some of the main pages ( As for |
4 participants
What is the purpose of this pull request? (put "X" next to an item, remove the rest)
• [x] Documentation update
Resolves #527
What is the rationale for this request?
We can clean up the
<frontmatter>of each page, within our documentation by using the layouts feature. Since #528 was fixed, we can proceed to use layouts with no issues.What changes did you make? (Give an overview)
Replaced the
header,footerandsiteNavvalues of<frontmatter>withlayoutTesting instructions:
Proposed commit message: (wrap lines at 72 characters)
Docs: update pages' frontmatter to use layouts
MarkBind documentation pages' frontmatter currently specifies 3 values
to insert headers, footers and site navigation. The issue with layouts
inserting siteNav CSS files has been fixed in #841 .
Therefore, let's update our documentation to use the layouts feature to
reduce the clutter in each pages' frontmatter. A separate layout for
both user guide and developer guide has been added.