Introduction
Welcome to the JBrowse 2 documentation.
Quick start guides
- Quick start for JBrowse desktop - a quick start guide to getting JBrowse desktop running on your machine
- Quick start for JBrowse web - a quick start guide to running JBrowse 2 in a browser
User guide
- User guide - for general usage, guided by screenshots and descriptions
Configuration
- Config guide - for detailed configuration settings
- See also autogenerated config docs e.g. BamAdapter
Tutorials
- Admin server - a guide for configuring JBrowse via the GUI with the admin-server tool
Developers
- Developer guide
- Writing a plugin using the plugin-template for JBrowse 2
- URL query parameter API
- See also autogenerated state model docs e.g. Assembly
Other resources
- FAQ - some Q&A for troubleshooting or other topics
- @jbrowse/cli - docs for our CLI tools for loading tracks, assemblies, text indexing, and more
- @jbrowse/img - docs for our command line image generator
- Embedded components - docs for our reusable React components on NPM
- JBrowseR - docs for our R htmlwidget usable in Shiny apps
- JBrowse Jupyter - docs for our Python dash component usable in Jupyter
Contact information
Feel free to contact us if you have questions, issues, suggestions, improvements, or feedback. Enjoy!