Skip to content

Add dark mode styling to docs#6814

Open
Brett-Best wants to merge 1 commit into
realm:mainfrom
Brett-Best:chore/add-dark-mode-docs
Open

Add dark mode styling to docs#6814
Brett-Best wants to merge 1 commit into
realm:mainfrom
Brett-Best:chore/add-dark-mode-docs

Conversation

@Brett-Best

Copy link
Copy Markdown
Contributor

Summary

  • add dark-mode styling to the Jazzy-generated documentation
  • cover page chrome, tables, inline/code blocks, search/typeahead, blockquotes, asides, and syntax highlighting
  • use APCA-audited Tailwind palette values so checked text pairs clear Lc 60

Validation

  • ruby -e 'require "yaml"; YAML.load_file(".jazzy.yaml")'
  • git diff --check
  • APCA audit script: 28 checked pairs >= Lc 60
  • swift run swiftlint generate-docs
  • bundle exec jazzy --build-tool-arguments=--disable-sandbox

Comment thread .jazzy.yaml
theme: fullwidth
clean: true
copyright: '© 2023 [JP Simard](https://jpsim.com) under MIT.'
head: |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if this can go into a separate file for easier access, syntax highlighting, ... Did you try that or check for an option?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants