https://github.com/jitsucom/documentation

Jitsu documentation. See at https://jitsu.com/docs/
https://github.com/jitsucom/documentation

Last synced: 10 months ago
JSON representation

Jitsu documentation. See at https://jitsu.com/docs/

• Host: GitHub
• URL: https://github.com/jitsucom/documentation
• Owner: jitsucom
• License: mit
• Created: 2021-03-09T23:14:31.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2021-03-31T12:17:02.000Z (about 5 years ago)
• Last Synced: 2025-06-25T09:43:26.474Z (about 1 year ago)
• Language: TypeScript
• Size: 86.9 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog/1.28.0-15-feb-2021.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Jitsu Documentation Repository

This repository contains documentation published at https://jitsu.com/docs. Feel free to suggest edits. Links:

* Visit [jitsu.com](https://jitsu.com)

* Check out [EventNative](https://github.com/jitsucom/jitsu), Jitsu open-source core

## How to use

The files are formatted as [mdx](https://mdxjs.com/) with few custom components ``, ``, ``, `` and ``.

Few caveats:

 * You can't use markdown inside React components, stick to HTML

 * For code inside components use `` as equivalent of `\`code\`` in markdown

 * For JetBrains users: [MDX plugin](https://plugins.jetbrains.com/plugin/14944-mdx) is highly suggested. Make sure that you added .md extension to Preferences → Editor → File Types → MDX. Our .md files are actually mdx, you just need to tell that to IDE

    * **Note!** Beware of IDEA's auto-import feature, it kills H1 header sometimes

## Deploy

After any pushed update submit the following command in `https://github.com/jitsucom/jitsu` repository:

```bash

git submodule update --remote

```