-
Notifications
You must be signed in to change notification settings - Fork 124
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
Docs: Update using footers section #253
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some comments on suggested improvements.
docs/userGuide/contentAuthoring.md
Outdated
|
||
By default, there is a `footer.md` file created for you in `_markbind/footers`. | ||
If you need additional footers for different pages, you can create footer files in the same folder and wrap the contents in a `<footer>` tag. | ||
Create a footer file in `_markbind/footers` and wrap the contents in a `<footer>` tag. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To create a new footer, make a new markdown file in _markbind/footers
. Wrap the contents of the footer with a <footer>
tag.
docs/userGuide/contentAuthoring.md
Outdated
Create a footer file in `_markbind/footers` and wrap the contents in a `<footer>` tag. | ||
You can create more than one footer file if you want different footers for different pages. | ||
|
||
A `footer.md` file has been created for you as a template in `_markbind/footers`, if you ran `init`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tip: All new sites created with init
will have a footer.md
automatically created for you in _markbind/footers
.
docs/userGuide/contentAuthoring.md
Outdated
<frontmatter> | ||
footer: myFooterFile.md | ||
</frontmatter> | ||
``` | ||
|
||
Note: | ||
- Only one footer file can be specified in the [front matter](#front-matter) per page, and you must include its file extension. | ||
- Updating the footer file requires a restart of the server to reflect the changes on [live preview](userQuickStart.html#preview-your-site). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you are using live preview, you must restart the server when updating the footer file to see the changes.
4497382
to
c50a350
Compare
docs/userGuide/contentAuthoring.md
Outdated
@@ -300,19 +306,20 @@ If you need additional footers for different pages, you can create footer files | |||
</footer> | |||
``` | |||
|
|||
After which, you must specify the file within [front matter](#front-matter)'s `footer` attribute to render the footer. | |||
After which, you must specify the file within a page's [front matter](#front-matter)'s `footer` attribute to render the footer. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe just page front matter's
(no need 's
after page
, looks weird to have two 's
appearing).
The rest LGTM, reads more user friendly now. |
@damithc for your review as you suggested the improvements for the footer's documentation. |
What is the purpose of this pull request? (put "X" next to an item, remove the rest)
• [X] Documentation update
Resolves #250
What is the rationale for this request?
User would like improved clarity on documentation.
Is there anything you'd like reviewers to focus on?