Conversation
🦋 Changeset detectedLatest commit: 606dc38 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
✅ Deploy Preview for genuine-druid-c4cc09 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…d clarity and structure
- Updated SCSS styles in _custom.scss to normalize font weight and style for chroma color palette. - Added fontsource.svg for local font hosting guidance. - Revised archetypes.md to include detailed usage instructions and examples. - Expanded fonts.md with a comprehensive setup guide for Fontsource. - Enhanced images.md with best practices for image usage and organization. - Improved layouts.md to clarify layout file structure and selection process. - Updated markdown.md with practical Markdown syntax examples and front matter details. - Revised pages.md to explain content file mapping to URLs and creation commands. - Enhanced partials.md with instructions on creating and using partials in layouts. - Expanded scripts.md to provide guidance on adding custom JavaScript and script organization. - Updated shortcodes.md with examples and instructions for creating custom shortcodes. - Revised styles.md to detail SCSS organization and customization options. - Updated hugo_stats.json to reflect new topics and tags for improved documentation navigation.
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
1 participant
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.
Summary
This pull request migrates the documentation site from Starlight 0.29.2 to Doks 1.9, resulting in a major restructuring of the codebase, configuration, and supporting files. The migration replaces the Astro-based Starlight setup with a Hugo-based Doks setup, introduces new configuration and theme files, updates editor and formatting settings, and adds custom assets and scripts for enhanced functionality and theming.
The most important changes are:
Migration from Starlight to Doks:
astro.config.mjsand replaced it with Hugo configuration files (config/_default/hugo.toml,config/_default/languages.toml) and archetypes (archetypes/default.md). This shifts the site from Astro/Starlight to Hugo/Doks as the static site generator and theme. [1] [2] [3] [4].changeset/yellow-trams-rush.md)Assets and Theming:
assets/js/custom.js,assets/js/docsearch.js). [1] [2]assets/scss/common/_fonts.scss,assets/scss/common/_variables-custom.scss,assets/scss/common/_variables-docsearch.scss). [1] [2] [3]Editor and Formatting Configuration:
.vscode/extensions.json,.vscode/settings.json). Removed the Astro-specific launch configuration. [1] [2] [3].prettierrc.yaml,.prettierignore). [1] [2].npmignoreto include config files for npm publishing.Licensing and Documentation:
LICENSEfile with the MIT license for the project.CHANGELOG.mdcontent, as the changelog process is now handled differently.These changes collectively transition the project to a new documentation framework, update supporting infrastructure, and lay the foundation for future development using Hugo and Doks.
Basic example
Include a basic example, screenshots, or links.
Motivation
Why are we doing this? What use cases does it support? What is the expected outcome?
Checks
npm run test(if relevant)