Reorganize the docs. #1041
Reorganize the docs. #1041
Conversation
|
|
||
| ## Syntax Highlighting | ||
|
|
||
| Most popular editors these days do support ES2015+ syntax highlighting. |
There was a problem hiding this comment.
How about:
These days, many popular editors support ES2015+ syntax highlighting out of the box, while some require installing additional extensions.
|
The options (at least most of them) are also valid for CLI usage, but maybe we should add a separate table there anyway? Especially to describe the common confusion on how to disable an option e.g. |
|
@danez I have moved the options section to the API docs. There's a blockquote. And we also link to that section from CLI page. UPDATE: We can document how to disable the option, though. |
|
I had a discussion with @hzoo and we agreed that this is the first step towards having better docs. I set the baseline and we need to further polish it in the following PRs. There's quite a bit of work left, I know. |
| --- | ||
| layout: docs | ||
| title: Editors | ||
| description: Learn how to use Babel in the editor of choice |
There was a problem hiding this comment.
Should this be (emphasis mine):
Learn how to use Babel in your editor of choice
|
👍 nice work @mareksuscak! |
|
@mareksuscak In the future we should discuss in #website on slack so there's no missing context |
|
|
||
| ## Syntax Highlighting | ||
|
|
||
| These days, many popular editors support ES2015+ syntax highlighting |
There was a problem hiding this comment.
Would it be interesting to have a screenshot of syntax highlighting somewhere on here?
There was a problem hiding this comment.
Absolutely. I can add that. If you happen to have such a picture with various ES syntax constructs in it, let me know. Otherwise, I'll create it myself.
| @@ -4,6 +4,8 @@ title: API | |||
| description: How to use the Node.js API. | |||
| permalink: /docs/usage/api/ | |||
| package: babel-core | |||
There was a problem hiding this comment.
I moved this doc in babel/babel (PR babel/babel#4938). It will be then included in the website at build-time (PR #1026)
Could you apply your modifications in babel repo ? Thanks.
There was a problem hiding this comment.
For clarification this would mean making a pr to babel/babel in the babel-core readme
and then adding {% include package_readme.html %} instead of the content here.
we can do it in another pr too?
|
Thanks @mareksuscak! |
Resolves #930 + adds a new section on configuring Editors to get syntax highlighting.
Here's how it looks
Noteworthy Changes: