Support custom templates directory #2006
Merged
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
jdkoren
force-pushed
the
custom_templates
branch
3 times, most recently
from
5e0f5f4 to
8b691b9
Compare
keertip
reviewed
Aug 22, 2019
lib/src/html/templates.dart
Outdated
| void replacePlaceholder(String key, String placeholder, List<String> paths) { | ||
| var template = partials[key]; | ||
| if (template != null && paths != null && paths.isNotEmpty) { | ||
| String replacement = paths.map((path) => File(path).readAsStringSync()) |
There was a problem hiding this comment.
Use 'p' instead of 'path', since path is used as prefix for package:path.
| 'class, constant, constructor, enum, function, index, library, method, mixin, ' | ||
| 'property, top_level_constant, top_level_property, typedef. Partial templates are ' | ||
| 'supported; they must begin with an underscore, and references to them must omit the ' | ||
| 'leading underscore (e.g. use {{>foo}} to reference the partial template _foo.html).'), |
There was a problem hiding this comment.
It would be good to have a check to see if all the expected templates are in the directory, and fail with the a message that lets the user know what's missing. The template files can change (working on one such change now), and it will be helpful to flag this with a check rather than a failure/stack trace.
There was a problem hiding this comment.
Added a check in templates.dart (and a test), but let me know if you want me to go about it in a different way.
Adds a (hidden) command-line flag to supply a directory with custom html templates to use. If not specified, dartdoc defaults to using the packaged templates. Change-Id: I4148ff388947b1e0e24aa63b598be00cb01ae220
jdkoren
force-pushed
the
custom_templates
branch
from
8b691b9 to
8249001
Compare
keertip
approved these changes
Aug 23, 2019
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.
Adds a (hidden) command-line flag to supply a directory with custom
html templates to use. If not specified, dartdoc defaults to using the
packaged templates.
Change-Id: I4148ff388947b1e0e24aa63b598be00cb01ae220