honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(aio): add VS Code advice to readme.md

This commit is contained in:
Ward Bell 2017-04-17 10:12:10 -07:00 committed by Pete Bacon Darwin
parent c2fca3d9e0
commit 93d8f8cd63
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
aio/README.md
View File

@ -54,9 +54,11 @@ extracting the documentation and generating JSON files that can be consumed by t
Full doc generation can take up to one minute. That's too slow for efficient document creation and editing.
While you can make small changes in a smart editor that displays formatted markdown (e.g,. VS Code), you
also want to see those changes displayed properly in the doc viewer. You'll want a quicker edit/view cycle
time.
You can make small changes in a smart editor that displays formatted markdown:
>In VS Code, _Cmd-K, V_ opens markdown preview in side pane; _Cmd-B_ toggles left sidebar
You also want to see those changes displayed properly in the doc viewer
with a quick, edit/view cycle time.
For this purpose, use the `yarn docs-watch` task, which watches for changes to source files and only
re-processes the the files necessary to generate the docs that are related to the file that has changed.