Skip to content

jt-lab-com/docs

Repository files navigation

JT-Lib & JT-Trader Documentation

Documentation for JavaScript Trading Libraries, built with Docusaurus.

🚀 Quick Start

🌐 Online Documentation: https://docs.jt-lab.com/

Installing Dependencies

yarn install

Development

yarn start

The Site Will be available at: http://localhost:3000

Production Build

yarn build

Testing Build

yarn serve

📚 Documentation Structure

  • JT-Lib - Core library for algorithmic trading
  • JT-Trader - High-level trading framework
  • Triggers - Automation system for triggers
  • Interfaces - TypeScript interfaces and types

🌐 Deploy to GitHub Pages

The site automatically deploys to GitHub Pages when pushing to the main branch.

GitHub Pages Setup

  1. Go to repository settings on GitHub
  2. In the "Pages" section, select source "GitHub Actions"
  3. With each push to main, the site will automatically update

🔧 Configuration

  • docusaurus.config.ts - main Docusaurus configuration
  • sidebars.ts - navigation structure
  • src/css/custom.css - custom styles

📝 Adding New Documentation

  1. Create a .md file in the appropriate folder
  2. Add frontmatter with id, title, sidebar_label
  3. Update sidebars.ts to add to navigation
  4. Run yarn start to check

🐛 Troubleshooting

Build Errors

  • Check all links in documentation
  • Make sure all files exist
  • Check Markdown Syntax

Image Issues

  • Use relative paths: ./images/example.png
  • Add width and height attributes for size control
  • Images automatically enlarge on click

📦 Dependencies

  • @docusaurus/core - Docusaurus core
  • @docusaurus/preset-classic - Classic preset
  • @mdx-js/react - MDX support
  • remark-gfm - GitHub Flavored Markdown
  • remark-images - Image processing

🔗 Useful Links

Documentation

JT-Lab Resources

Documentation

About

Jt-Trader Manual

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors