Add dashing config file for generating docset from flutter docs #24374
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.
The aim of this PR is to introduce
.docset
for Flutter APIs in relation to #9955.A brief description about building this docset:
Prerequisites
Docset building procedure
dev/bots/docs.sh
to build Flutter docs.dashing build --source ./doc --config dashing.json
to build the docset.Issues of this configuration file
There is no configuration field for the version number in the requirements of
dashing.json
. The version number could be specified at a 'Dash documentation feeds' file. For more details, please read: https://kapeli.com/docsets#dashdocsetfeed. In addition, here is my minimal example: https://github.com/imWildCat/flutter-docset/blob/master/flutter.xml.As for
icon32x32
indashing.json
,dev/docs/doc/flutter/static-assets/favicon.png
is used currently. This icon image works well in the Dash.app though this image is actually '64x64'.The selectors of different entry types should be improved for better doc navigation.
References