Init. custom site design - #1278
Open
trespaul wants to merge 1 commit into
Open
Conversation
- remove Starlight
- add packages
- Expressive Code (directly)
- Tailwind
- astro-iconset & Material Design Icons
- update packages
- configure Sätteri to parse directives
(rendering to HTML still to be implemented)
- configure content to use custom loader
- add custom site config for site-specific information
(title, description, copyright, links)
- add tentative custom colour theme
- with Expressive Code themes (VS Code theme format)
- scaffold custom components
- Footer (copyright, copyright, imprint, privacy policy)
- Head (`<head>`)
- Header (site title, search, mobile menu toggle,
social icons, light/dark theme selector)
- SiteTitle
- SocialIcons
- TableOfContents & TableOfContentsItem
- skeleton/placeholder components
- Sidebar
- Search
- MobileMenuToggle
- ThemeSelector
- layouts
- Base: Head, Header, Sidebar, Footer
- Page: wrap contents & TableOfContents in Base;
define prose style
- set tsconfig to strictest for Type Safety™
- landing page: links to current docs
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2026-08-05-documentation-team-meeting-notes/79372/2 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
To avoid the docs site looking like Just Another Starlight Site, I've replaced Starlight with a custom design. See below for a list of changes — please let me know if (and how) I should split these into more granular commits.
The site rendered in this PR is basically non-functional / cosmetic, and all links point to the current documentation, but some components are already working with test data (e.g.
TableOfContents). (See https://github.com/trespaul/nix.dev/tree/wip-custom for in-progress work).Preview
Live preview: https://preview-nix-docs.trespaul.workers.dev/
Things Done
Footer(copyright, copyright, imprint, privacy policy)Head(just<head>)Header(site title, search, mobile menu toggle, social icons, light/dark theme selector)SiteTitleSocialIconsTableOfContents&TableOfContentsItemSidebarSearchMobileMenuToggleThemeSelectorBase:Head,Header,Sidebar,FooterPage: wrap contents &TableOfContentsinBase; define prose styleThings to be done next
(In no particular order:)