Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TODO #1

Open
8 of 40 tasks
letientai299 opened this issue Dec 28, 2016 · 0 comments
Open
8 of 40 tasks

TODO #1

letientai299 opened this issue Dec 28, 2016 · 0 comments

Comments

@letientai299
Copy link
Owner

letientai299 commented Dec 28, 2016

TODO

Doc

  • Write proper Readme.
  • Document source code.
  • Demo

Bugs

  • TOC show on all body tags, include one under iframe
  • TOC show also the hidden elements, when use with Stylish custom style.
  • Only resizable on Github
  • Auto highlighted header is not works correctly.
  • CSS is override by other plugins/scripts.
  • Shortcut doesn't work if the page is not focused.
  • TOC overlap with contents
  • TOC not updated when open other article within the current page.
  • Header style is affected by site css.

Spread the world

  • Make a github.io page for this.
  • Share to friends for beta-testing
  • Publish on OpenUserJS, Userscript...

Enhancements

  • Auto upgrade from user side.
  • Enable sites list should be configurable.
  • Should have configurable shortcuts
  • Icons, animations.
  • Better Article detection
  • Expand, Close animation
  • More shortcut keys: Zooms, Search, Next, Back, Expand, Close
  • Configurable css
  • More default style
  • Settings
  • Make it an standalone addon, not depend on any script engine.
  • Test on other user script engines.
  • Test on other browser.
  • Resizable
  • Movable (floating mode)
  • Left/Right
  • TOC search
  • Should remember the last status (show/hide, width) for a specific site.

Dev

  • Unit test
  • Dev setup: auto reload, shorter edit-run circle
  • npm setup
  • Separate js, css, html. Make grunt/gulp tasks to combine everything in one bundle.

Integration

  • Integrate with VimFx mark and g[, g] features.
  • Integrate with AsciiDoc preview addon.
  • Sync settings with Firefox/Google profiles
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant