basarat / basarat/TypeScriptDeepDive
Recommend to use a plugin for generating "Treeview" for each article in the book
- Dominant language
- JavaScript
- Stars
- 71
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
[**gitbook-treeview**](https://github.com/aleen42/gitbook-treeview) is a Gitbook plugin designed for generating structures for articles of a book. As the following picture shown, the main structure of a whole article has been clearly shown before contents, and each title has also been directed to a corresponding part. TypeScript Deep Dive is a large book, which has integrated with Gitbook, and I hope that the plugin can helps to enhance readability. If you like it, I hope you can star my project too, and thanks for your appreciations. As for the picture, it's an article named ["Asynchronous Programming"](https://aleen42.gitbooks.io/personalwiki/content/Programming/JavaScript/async_programming/async_programming.html) in my personal wiki book.

Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing how GitBook is configured for TypeScript Deep Dive and the linked gitbook-treeview project. Determine how the plugin would be enabled for the book, then verify that article structures appear before content and link to the corresponding sections.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100