JuJuBu SDK

https://docs.jujubu.com
Admin
JuJuBu SDK is a TypeScript library that provides a simple and type-safe way to interact with JuJuBu...
Tokens:1,109
Snippets:7
Trust Score:9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Integrating Documentation Checks in CI/CD (YAML)

Source: https://context7.com/context7/jujubu/llms.txt

A GitHub Actions workflow example for checking the existence and validity of markdown files, and for verifying links within the documentation.

```yaml
# .github/workflows/docs-check.yml
name: Documentation Check

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  check-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: Check markdown files exist
        run: |
          if [ ! -f "README.md" ]; then
            echo "README.md is missing"
            exit 1
          fi

      - name: Validate markdown syntax
        run: |
          npm install -g markdownlint-cli
          markdownlint '**/*.md'

      - name: Check for broken links
        run: |
          npm install -g markdown-link-check
          find . -name '*.md' -exec markdown-link-check {} \;
```

--------------------------------

### Cloning and Managing Jujubu SDK Repository (Git)

Source: https://context7.com/context7/jujubu/llms.txt

Provides commands for cloning the Jujubu SDK documentation repository, navigating into it, and checking its status using Git.

```bash
# Clone via HTTPS
git clone https://github.com/context7/jujubu.git

# Navigate to the repository
cd jujubu

# View repository status
git status
```

--------------------------------

### Exporting and Converting Jujubu SDK Documentation (Bash)

Source: https://context7.com/context7/jujubu/llms.txt

Demonstrates using Pandoc to convert markdown documentation to HTML, PDF, and reStructuredText, and setting up MkDocs for serving a documentation site.

```bash
# Convert markdown to HTML using pandoc
pandoc jujubu-sdk-docs-*.md -o jujubu-sdk-docs.html

# Convert to PDF
pandoc jujubu-sdk-docs-*.md -o jujubu-sdk-docs.pdf

# Convert to reStructuredText for Sphinx
pandoc jujubu-sdk-docs-*.md -o jujubu-sdk-docs.rst

# Generate documentation site using MkDocs
cat > mkdocs.yml << EOF
site_name: Jujubu SDK Documentation
nav:
  - Home: README.md
  - SDK Documentation: jujubu-sdk-docs-28686e38e2d780b1827dc5179e802642.md
theme:
  name: material
EOF

mkdocs serve
```

--------------------------------

### Accessing and Searching Jujubu SDK Documentation (Bash)

Source: https://context7.com/context7/jujubu/llms.txt

Demonstrates how to read, search within, and list markdown documentation files in the Jujubu SDK repository using standard bash commands.

```bash
# Read the primary documentation file
cat jujubu-sdk-docs-28686e38e2d780b1827dc5179e802642.md

# Search for specific terms in documentation
grep -r "API" *.md

# List all markdown files
ls -la *.md
```

--------------------------------

### Repository File Structure and Size Check (Bash)

Source: https://context7.com/context7/jujubu/llms.txt

Shows commands to display the directory structure and check the file sizes of markdown documents within the Jujubu SDK repository.

```bash
tree .

# Check file sizes
du -h *.md
```

--------------------------------

### Viewing Documentation History with Git (Bash)

Source: https://context7.com/context7/jujubu/llms.txt

Illustrates how to view the commit history, detailed changes, and specific file modifications within the Jujubu SDK documentation repository using Git.

```bash
# View commit history
git log --oneline

# View detailed commit with changes
git log -p

# View changes for specific file
git log -p jujubu-sdk-docs-28686e38e2d780b1827dc5179e802642.md

# Compare current version with previous commit
git diff HEAD~1 jujubu-sdk-docs-28686e38e2d780b1827dc5179e802642.md
```

--------------------------------

### Programmatic Search of Documentation Content (JavaScript)

Source: https://context7.com/context7/jujubu/llms.txt

A Node.js script to search for a given term across all markdown files in the current directory, returning matches with file, line number, and content.

```javascript
// search-docs.js
const fs = require('fs');
const path = require('path');

// Read all markdown files
function searchDocumentation(searchTerm) {
  const files = fs.readdirSync('.')
    .filter(f => f.endsWith('.md'));

  const results = [];

  files.forEach(file => {
    const content = fs.readFileSync(file, 'utf-8');
    const lines = content.split('\n');

    lines.forEach((line, index) => {
      if (line.toLowerCase().includes(searchTerm.toLowerCase())) {
        results.push({
          file: file,
          line: index + 1,
          content: line.trim()
        });
      }
    });
  });

  return results;
}

// Usage
const matches = searchDocumentation('SDK');
console.log(`Found ${matches.length} matches:`);
matches.forEach(m => {
  console.log(`${m.file}:${m.line} - ${m.content}`);
});
```
Tokens:
Raw