Update Docusaurus and Web Docs Styling + Workflow Fix #65
Conversation
This file contains hidden or 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 the web docs font to match those expected by the HMS communication guide section on web design. This includes a switch to 'Calibri' for the regular/body font, and 'Lato' as the heading font. HMS' own website uses a font called Industry Book, but this is not publicly accessible, and the HMS communication guide acknowleges this and recommends 'Lato' as the first alternative.
Changed the primary color of the web docs to 'HMS Blue' (#043D5D). To best contrast in dark mode, the primary color in dark mode is changed to 'Accent Blue' (#1268B3). There is no clear color palette for the theme light/lighter/lightest options, so those values have been set to 'HMS Light Grey' (#EFF0F1). The theme dark/darker/darkest palette has been aligned with dark as 'Accent Blue' (#1268B3), darker as 'Marine Grey' (#485F70), and darkest as 'HMS Blue' (#043D5D). Values which were common between light and dark mode were eliminated from the specific dark mode CSS block to simplify. An error regarding a duplicate definition for 'ifm-color-primary-light' in the default/light mode CSS was also corrected to replace the missing 'ifm-color-primary-lightest' definition. Font color was updated to match the HMS standard color 'Textbody' (#333333). In dark mode, this is inverted to 'Light Grey' (#EFF0F1).
This defines SEO/crawler rules for the Docusaurus websites. Generally, this allows all crawlers but excludes the /docs/imported folder. This has been excluded since its contents will be indexed with the pages which import it. Separate indexing may result in confusing indexed links which are not separately useful or easily understood.
alexjhawk
force-pushed
the
dev/docs
branch
3 times, most recently
from
df982b9 to
7754db4
Compare
Updated to the latest major version of the Docusaurus platform, currently at v3.1.1. A bug regarding imported docs was identified and fixed, which caused an infinite webpack refresh loop. The resolution disables any runtime downloads of imported content, and adds the download (and clear) steps to the package.json processes.
Resolved a bug while running `yarn build` which was caused by an example file name being parsed as if it were a variable name. This has been resolved by changing the encompassing quotes to a code block.
Added metadata which is required by the Open Graph protocol (for rich social media and link previews).
Added support for SEO keyword customization via the ScDocusaurusConfig.js file.
Updated the release (build outputs) workflow to correct a bug which was causing releases to not properly be marked as a release or pre-release. The header of the workflow file was also updated accordingly. fixes #59.
alexjhawk
changed the title
|
Updates to bring Docusaurus in line with the HMS communication guide styling, as well as upgrading to Docusaurus v3, adding support for PWA, and improved SEO. A fix for the pre-release detection issue (#59) is also included. |
TomKimsey
approved these changes
Mar 19, 2024
it-hms
approved these changes
Mar 19, 2024
Responding here for context: I plan on sweeping for candidate common docs across the starter project and related repositories to pull anything up in to the common docs repo soon. |
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.
No description provided.