feat: Minimal format #140
Merged
feat: Minimal format #140
Conversation
This file contains 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
When including documentation into a dedicated page, we have different needs. - Add `--anchor-prefix` to avoid unnecessary/inaccurate `function-library-` prefix. - Don't render a header when description and category are empty. These can be handled by the parent document when using an "include" feature of a markdown processor / site generator. - Add this usage to the README. Good to help non-Nixpkgs users and let nixdoc grow outside of that context.
infinisil
approved these changes
Dec 2, 2024
|
@infinisil Is it possible to cut a release with this fix so nixdoc can be updated in nixpkgs? |
Merged
|
Thanks! |
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.
When including documentation into a dedicated page, we have different needs.
Add
--anchor-prefixto avoid unnecessary/inaccuratefunction-library-prefix.Don't render a header when description and category are empty. These can be handled by the parent document when using an "include" feature of a markdown processor / site generator.
Add this usage to the README. Good to help non-Nixpkgs users and let nixdoc grow outside of that context.
Also tested with #139