Skip to content
This repository has been archived by the owner on Jun 16, 2020. It is now read-only.

Latest commit

 

History

History
43 lines (28 loc) · 1.06 KB

README.md

File metadata and controls

43 lines (28 loc) · 1.06 KB
Raw

atom-gitbook package

Plugin provides a Tree view for Gitbook Summary files, along with functionality that entails.

Features

  • Preview Table of Contents from Summary.md
  • Auto-toggle Markdown Preview if installed
  • Reorder Chapters from the Table of Contents
  • Add existing files to the ToC from the tree view
  • Add and remove chapters
  • Create underlying Markdown file if it doesn't exist

Demo

Developer instructions.

Clone the repo

git clone git@github.com:cthos/atom-gitbook.git

Link it to your gitbook directory

ln -s /path/to/atom-gitbook ~/.atom/packages/atom-gitbook

NPM Install

cd atom-gitbook
apm install

It might also be necessary to apm rebuild from time-to-time as atom gets updated.

Problems on Mac

I've been seeing an issue where the package will not rebuild unless you do an npm install using node 0.10.35. I've tested this with n to manage the versions, but nvm should also work... I think.

More info here: https://www.alextheward.com/blog/apm-rebuild/