Skip to content
This repository has been archived by the owner on Aug 29, 2023. It is now read-only.

Latest commit

 

History

History
47 lines (31 loc) · 1.17 KB

README.md

File metadata and controls

47 lines (31 loc) · 1.17 KB
Raw

page-contents-sidebar

Sidebar Extension for Markdown on Gist

page-contents-sidebar_demo

Features

  • Display header title of Markdown file
  • Jump to target area
  • Change the depth of the display header
  • Track and focus on current browsing points
  • Change the sidebar width
  • The sidebar can be hidden with a single button

Future

Scheduled to support other sites such as GitHub and Confluence.

Development

Start development

$ cd page-contents-sidebar
$ npm install

Build, run, and watch app

Modify src files and run and watch app by building with gulp

$ npm start

Inspect app

Open tmp/app directory as extension in Chrome browser, chrome://extensions/

Deployment app to Chrome Extension

  1. Update version of package.json
  2. Run npm run-script build or gulp build and check tmp/app TODO: Use npm dist with zip the dir
  3. Create a zip file of tmp/app
  4. Go to Chrome Ex Dashboard and upload the zip file
  5. Push update to master and create release and tag