Docs: Update using footers section #253
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yamgent
reviewed
Jun 5, 2018
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.
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.
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.
If you are using live preview, you must restart the server when updating the footer file to see the changes.
Chng-Zhi-Xuan
force-pushed
the
250-footer-docs
branch
from
4497382
to
c50a350
Compare
yamgent
reviewed
Jun 6, 2018
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.
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. |
yamgent
approved these changes
Jun 7, 2018
|
@damithc for your review as you suggested the improvements for the footer's documentation. |
damithc
approved these changes
Jun 7, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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?