docs: Update markdown formatting of docs #287
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
Update markdown formatting of docs in mostly cosmetic ways: - Remove horizontal lines between samples of builtin documentation - Turn h4 headers into h3 headers in the usage documentation Horizontal lines and h4 were motivated by the way GitHub renders markdown. As we are shifting to evy.dev we don't need these anymore as we have full control of styles and spacing.
|
firebase-deployment for 485e2ac |
Fix favicon and logo image paths to relative to the current docs page. This will allow for image display on docs.evy.dev and for docs pages in sub-directories.
Rename all sidemenu to sidebar is this seems to be the more commonly used term. On the GitHub wikis for example, _sidebar.md holds the contents of the sidebar. In a follow up commit we will use the same convention for providing the docs sidebar and for consistency we will start renaming here as a preparatory step.
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.
Update markdown formatting of docs in mostly cosmetic ways:
Horizontal lines and h4 were motivated by the way GitHub renders markdown. As
we are shifting to evy.dev we don't need these anymore as we have full
control of styles and spacing.
While at it, also add a small fix to docs template to link to favicon
and logo via relative path.
Also rename
sidemenutosidebareverywhere as a preparatory stepfor adding a custom docs sidebar. Sidebar seems to be the more commonly
used technical term.