fix: remove YAML metadata from doc.md to fix GitHub Pages display #405
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
The FORD documentation generator was displaying raw YAML metadata on the GitHub Pages site instead of parsing it as configuration. Changes: - Removed YAML front matter from doc.md (configuration now in fpm.toml) - Simplified fpm.toml [extra.ford] section to essential settings - Documentation now displays clean content without metadata artifacts Fixes #399
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Summary
Problem
The GitHub Pages documentation at https://lazy-fortran.github.io/fortplot/ was showing raw YAML configuration text instead of a clean summary. This was due to incorrect FORD metadata format in doc.md.
Solution
Testing
ford doc.mdFixes #399