No markup in shortdesc #1952
Merged
No markup in shortdesc #1952
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
|
See http://ol3js.org/en/master/examples/?q=draw for an example of how markup in shortdesc is currently rendered. The tag name in this case is also used as a search term (e.g. http://ol3js.org/en/master/examples/?q=code). |
The example parser and index template don't handle markup in the shortdesc element. Use the docs element instead.
This strips markup from elements with id attributes that we care about: title, shortdesc, tags. This will only work for people who use `npm install && npm start` to browse examples. The other example parser doesn't strip this markup, so it should still not be used in these elements.
|
Looks good. Please merge. |
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.
The example parser and index template don't handle markup in the shortdesc element. Use the docs element instead.
Now that we have Node as a dependency, I'd like to propose that we move our examples into templates with YAML front matter (for things like tags, classes used, description) and have a Node based task to build the examples. I'd like to unify how we build the examples and rest of the website. And I also think it makes sense to have these tasks (and the documentation building) run on Node - since this is a JavaScript project, I think we should all be able to contribute to JavaScript build tools. I know this is a different subject than the ticket at hand, but all the copy/paste in the examples is getting to me.