This book is developed using GitBook. Authored in Markdown files (I use atom).
Here's how to setup a Dev Environment:
npm install gitbook-cli -g
gitbook serve .
Note: serve needs port
35729
(for live reload) and4000
for serving http://localhost:4000.
Also you can mostly just edit the .md
files in /docs
using github and create a Pull Request (PR).
All the code for the book is in the /code
folder. Tested with atom-typescript
.
- Links best work if they are relative (e.g.
./foo.md
) to the current file. - For links in the same file (
#foo-bar
style links) best to click the heading on github to get what gitbook expects.
Thanks to the TypeScript team for providing much of the docs: https://github.com/Microsoft/TypeScript/wiki/Architectural-Overview that are used to write the compiler story.