docs-for-ai/marimo/INDEX.xml at main · michellepace/docs-for-ai · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<docs_index>
  <source>
    <title>marimo</title>
    <description>Reactive Python notebook environment with automatic cell execution, interactive UI elements, SQL support, Git-friendly storage, deployable apps, AI assistance, package management, deterministic execution, and reproducibility features.</description>
    <source_url>https://docs.marimo.io/#inspiration</source_url>
    <local_file>marimo.md</local_file>
    <scraped_at>2025-11-11</scraped_at>
  </source>
  <source>
    <title>Installation - marimo</title>
    <description>Installation guide covering virtual environment setup with pip, uv, and conda, minimal installation commands, recommended dependencies bundle including SQL cells, AI completion, dataframe plotting, formatting, and IPYNB export features.</description>
    <source_url>https://docs.marimo.io/getting_started/installation</source_url>
    <local_file>installation-marimo.md</local_file>
    <scraped_at>2025-11-11</scraped_at>
  </source>
  <source>
    <title>Quickstart - marimo</title>
    <description>marimo CLI essentials including tutorial access, notebook editing, app deployment with marimo run, script execution, Jupyter conversion, exporting to formats, optional dependencies, GitHub Copilot integration, and cloud sharing.</description>
    <source_url>https://docs.marimo.io/getting_started/quickstart</source_url>
    <local_file>quickstart-marimo.md</local_file>
    <scraped_at>2025-11-11</scraped_at>
  </source>
  <source>
    <title>Key Concepts - marimo</title>
    <description>Core marimo concepts including reactive execution, cell dependency graphs, interactive UI elements with marimo.ui, SQL cell support, output visualisation, running notebooks as web apps or scripts, and eliminating hidden state.</description>
    <source_url>https://docs.marimo.io/getting_started/key_concepts</source_url>
    <local_file>key-concepts-marimo.md</local_file>
    <scraped_at>2025-11-11</scraped_at>
  </source>
  <source>
    <title>Recipes - marimo</title>
    <description>Code snippets for control flow, UI element grouping (arrays, dictionaries, forms), button patterns (counters, toggles, triggers), conditional execution with mo.stop, timers with mo.ui.refresh, and caching with mo.cache and mo.persistent_cache.</description>
    <source_url>https://docs.marimo.io/recipes</source_url>
    <local_file>recipes-marimo.md</local_file>
    <scraped_at>2025-11-11</scraped_at>
  </source>
  <source>
    <title>Commands - marimo</title>
    <description>Comprehensive marimo CLI reference covering edit, run, check, convert, export formats (HTML, WASM, ipynb, markdown, script), config management, tutorial commands, environment debugging, shell completion, notebook recovery, and AI-generated notebook creation.</description>
    <source_url>https://docs.marimo.io/cli</source_url>
    <local_file>commands-marimo.md</local_file>
    <scraped_at>2025-11-11</scraped_at>
  </source>
  <source>
    <title>FAQ - marimo</title>
    <description>Frequently asked questions covering differences from Jupyter, reactive execution, UI elements, forms, markdown, plotting, layouts, deployment, remote server usage, module reloading, type annotations, and troubleshooting common issues.</description>
    <source_url>https://docs.marimo.io/faq</source_url>
    <local_file>faq-marimo.md</local_file>
    <scraped_at>2025-11-11</scraped_at>
  </source>
  <source>
    <title>Marimo — The Dan MacKinlay stable of variably-well-consider’d enterprises</title>
    <description>Personal perspective on marimo covering trade-offs versus Jupyter, HPC cluster development, VS Code integration, remote access, debugging, coding assistant workflows, export/import commands, PEP 723 sandboxing, dotenv configuration, and file format.</description>
    <source_url>https://danmackinlay.name/notebook/marimo.html</source_url>
    <local_file>marimo-the-dan-mackinlay-stable-of-variably-well-considerd-enterprises.md</local_file>
    <scraped_at>2025-11-11</scraped_at>
  </source>
  <source>
    <title>User Guide - marimo</title>
    <description>Index of user guide topics including reactivity, interactivity, outputs, data manipulation, package management, AI generation, deployment, configuration, state management, debugging, testing, exporting, and migration from Jupyter.</description>
    <source_url>https://docs.marimo.io/guides</source_url>
    <local_file>user-guide-marimo.md</local_file>
    <scraped_at>2025-11-11</scraped_at>
  </source>
  <source>
    <title>Lint Rules - marimo</title>
    <description>marimo linting system with marimo check command, categorised rules including breaking errors (unparsable cells, multiple definitions, circular dependencies), runtime issues (self-import), and formatting rules with auto-fix capabilities.</description>
    <source_url>https://docs.marimo.io/guides/lint_rules</source_url>
    <local_file>lint-rules-marimo.md</local_file>
    <scraped_at>2025-11-11</scraped_at>
  </source>
  <source>
    <title>DataFrames - marimo</title>
    <description>Interactive dataframe features with Pandas and Polars including rich display, no-code transformations with mo.ui.dataframe, custom filters using UI elements, row selection with mo.ui.table, and dataframe panels for exploration and visualisation.</description>
    <source_url>https://docs.marimo.io/guides/working_with_data/dataframes</source_url>
    <local_file>dataframes-marimo.md</local_file>
    <scraped_at>2025-11-11</scraped_at>
  </source>
  <source>
    <title>SQL - marimo</title>
    <description>SQL integration with DuckDB, querying dataframes and databases (SQLite, Postgres), output types (native, Polars, Pandas), f-string parameterisation, database connections via UI or code, data source auto-discovery, SQL linting and formatting.</description>
    <source_url>https://docs.marimo.io/guides/working_with_data/sql</source_url>
    <local_file>sql-marimo.md</local_file>
    <scraped_at>2025-11-11</scraped_at>
  </source>
  <source>
    <title>Plotting - marimo</title>
    <description>Plotting library support including Matplotlib, Seaborn, Plotly, Altair, HoloViews, reactive plots via mo.ui.altair_chart and mo.ui.plotly, automatic selections, transformations, interactive matplotlib plots, and built-in chart builder.</description>
    <source_url>https://docs.marimo.io/guides/working_with_data/plotting</source_url>
    <local_file>plotting-marimo.md</local_file>
    <scraped_at>2025-11-11</scraped_at>
  </source>
  <source>
    <title>Using your own editor - marimo</title>
    <description>File watching with --watch flag, marimo file format, cells as functions with @app.cell, top-level functions and classes, type hints and autocompletion, markdown format, watching modules and data files, WebAssembly hot-reloading.</description>
    <source_url>https://docs.marimo.io/guides/editor_features/watching</source_url>
    <local_file>using-your-own-editor-marimo.md</local_file>
    <scraped_at>2025-11-11</scraped_at>
  </source>
  <source>
    <title>Best practices - marimo</title>
    <description>Coding practices for marimo notebooks covering global variable management, descriptive naming, function encapsulation, mo.stop for execution control, module splitting, mutation minimisation, avoiding on_change handlers, and writing idempotent cells.</description>
    <source_url>https://docs.marimo.io/guides/best_practices</source_url>
    <local_file>best-practices-marimo.md</local_file>
    <scraped_at>2025-11-11</scraped_at>
  </source>
  <source>
    <title>HTML head - marimo</title>
    <description>Custom HTML head configuration through html_head_file parameter enabling analytics, custom fonts, meta tags, and external scripts with examples for Google Analytics, fonts, SEO metadata, and libraries.</description>
    <source_url>https://docs.marimo.io/guides/configuration/html_head</source_url>
    <local_file>html-head-marimo.md</local_file>
    <scraped_at>2025-11-11</scraped_at>
  </source>
  <source>
    <title>Theming - marimo</title>
    <description>Custom CSS file integration for notebook theming, CSS variables for fonts, project-level theme configuration, dark mode forcing, cell-specific styling, data attributes for targeting, and community theme library.</description>
    <source_url>https://docs.marimo.io/guides/configuration/theming</source_url>
    <local_file>theming-marimo.md</local_file>
    <scraped_at>2025-11-11</scraped_at>
  </source>
  <source>
    <title>Snippets - marimo</title>
    <description>Snippet configuration via marimo.toml including custom_paths for custom snippet directories, include_default_snippets flag, custom snippet creation, snippet file format as marimo App notebooks, and managing default snippets.</description>
    <source_url>https://docs.marimo.io/guides/configuration/snippets</source_url>
    <local_file>snippets-marimo.md</local_file>
    <scraped_at>2025-11-11</scraped_at>
  </source>
  <source>
    <title>LLM Providers - marimo</title>
    <description>Configuring LLM providers in marimo via marimo.toml: model roles (chat, edit, autocomplete), provider routing, API configuration for OpenAI, Anthropic, AWS Bedrock, Google AI, Azure, GitHub, OpenRouter, Ollama, and OpenAI-compatible providers.</description>
    <source_url>https://docs.marimo.io/guides/configuration/llm_providers</source_url>
    <local_file>llm-providers-marimo.md</local_file>
    <scraped_at>2025-11-11</scraped_at>
  </source>
</docs_index>