### Setup Source: https://github.com/skepticmystic/breadcrumbs/blob/master/CONTRIBUTING.md Clones the repository, navigates into the directory, and installs dependencies using Bun. ```bash git clone https://github.com/SkepticMystic/breadcrumbs cd breadcrumbs bun install ``` -------------------------------- ### Create List Index Example Source: https://github.com/skepticmystic/breadcrumbs/wiki/Commands Example of the nested markdown list generated by the Create List Index command. ```markdown - [[A]] - [[B]] - [[C]] - [[D]] - [[E]] - [[F]] ``` -------------------------------- ### Breadcrumbs Codeblock Example Source: https://github.com/skepticmystic/breadcrumbs/wiki/Views Example of using the `breadcrumbs` codeblock language to render a tree of paths. ```yaml type: tree dir: down depth: 0-3 sort: basename desc ``` -------------------------------- ### Frontmatter Links Example Source: https://github.com/skepticmystic/breadcrumbs/wiki/Explicit Edge Builders Example of using YAML frontmatter to define parent and child relationships between notes. ```yaml --- parent: "[[A]]" child: ["[[B]]", "[[C]]"] --- ``` -------------------------------- ### Dataview Note Example Source: https://github.com/skepticmystic/breadcrumbs/wiki/Explicit Edge Builders An example Dataview query to add child edges to notes tagged with '#tag' and located in the 'Folder' directory. ```yaml BC-dataview-note-query: "#tag" AND "Folder" BC-dataview-note-field: child ``` -------------------------------- ### List Note Structure Example Source: https://github.com/skepticmystic/breadcrumbs/wiki/Explicit Edge Builders Example illustrating the hierarchical structure of a List Note and how edges are formed. ```markdown - [[A]] - [[B]] - [[C]] - [[D]] ``` -------------------------------- ### Dataview Links Example Source: https://github.com/skepticmystic/breadcrumbs/wiki/Explicit Edge Builders Example of using Dataview metadata within the content of a note to define parent and child relationships. ```text parent:: [[A]] child:: [[B]], [[C]] ``` -------------------------------- ### Field Overrides Example Source: https://github.com/skepticmystic/breadcrumbs/wiki/Explicit Edge Builders This example demonstrates how to override the default `BC-list-note-field` on a per-item basis by adding the field before the link. ```markdown --- BC-list-note-field: down --- - [[A]] - child [[B]] ``` -------------------------------- ### Neighbor Field Example Source: https://github.com/skepticmystic/breadcrumbs/wiki/Explicit Edge Builders This example demonstrates how to add edges based on the neighbors of each list item using the `BC-list-note-neighbour-field`. ```yaml BC-list-note-neighbour-field: ``` -------------------------------- ### Development Watch Mode Source: https://github.com/skepticmystic/breadcrumbs/blob/master/CONTRIBUTING.md Starts the development server in watch mode, which rebuilds the main JavaScript and CSS files on every change. ```bash bun run dev ``` -------------------------------- ### Markdown Links with Dataview Source: https://github.com/skepticmystic/breadcrumbs/wiki/Explicit Edge Builders Example of how to define edges using markdown links when Dataview is enabled. ```markdown field:: [note name](path/to/note.md) ``` -------------------------------- ### Exclude List Note Behavior Source: https://github.com/skepticmystic/breadcrumbs/wiki/Explicit Edge Builders This example shows how to exclude the default behavior where the list note itself links to the top-level list items by adding the `BC-list-note-exclude` field to the frontmatter. ```yaml BC-list-note-exclude: true ``` -------------------------------- ### Basic Hierarchy Example Source: https://github.com/skepticmystic/breadcrumbs/wiki/Hierarchies Defines the unchangeable directions and customizable fields for structuring notes within the Breadcrumbs hierarchy system. ```plaintext up: parent down: child same: sibling prev: before next: after ``` -------------------------------- ### Format code Source: https://github.com/skepticmystic/breadcrumbs/blob/master/wasm/README.md Formats the code using cargo fmt. ```bash cargo fmt ``` -------------------------------- ### Build WASM package Source: https://github.com/skepticmystic/breadcrumbs/blob/master/wasm/README.md Builds the WASM package for the web target. Packages will be downloaded on the first build. ```bash wasm-pack build --target web ``` -------------------------------- ### Build Commands Source: https://github.com/skepticmystic/breadcrumbs/blob/master/CONTRIBUTING.md Commands for building the project, including type checking and bundling. ```bash bun run build # type-check + svelte-check + bundle ``` ```bash bun run tsc -noEmit -skipLibCheck # type-check only ``` ```bash bun run svelte-check # Svelte type-check only ``` -------------------------------- ### Commands Source: https://github.com/skepticmystic/breadcrumbs/blob/master/CLAUDE.md Common commands for development, building, testing, linting, formatting, and WASM operations using bun. ```bash # Development (watches TypeScript + CSS in parallel) bun run dev # Production build (type-checks, svelte-check, then bundles) bun run build # Run all tests (vitest) bun run test # Run a single test file bun run test tests/settings/migration.test.ts # Type-check only (no emit) bun run tsc -noEmit -skipLibCheck # Svelte type-check bun run svelte-check # Lint (ESLint + cargo clippy) bun run lint # Format (prettier + cargo fmt) bun run fmt # WASM — rebuild after any Rust changes bun run wasm:build # release bun run wasm:dev # debug (faster, larger) bun run wasm:test # Rust unit tests via wasm-pack ``` -------------------------------- ### Test WASM package Source: https://github.com/skepticmystic/breadcrumbs/blob/master/wasm/README.md Tests the WASM package using wasm-pack test with node target and test features. ```bash wasm-pack test --node --features test ``` -------------------------------- ### Testing Commands Source: https://github.com/skepticmystic/breadcrumbs/blob/master/CONTRIBUTING.md Commands for running various tests, including all Vitest tests, specific files, and Rust unit tests for the WebAssembly module. ```bash bun run test # all Vitest tests ``` ```bash bun run test tests/settings/migration.test.ts # single file ``` ```bash bun run wasm:test # Rust unit tests (wasm-pack) ``` -------------------------------- ### Recursive Folder Note Configuration Source: https://github.com/skepticmystic/breadcrumbs/wiki/Explicit Edge Builders Frontmatter to enable recursive edge creation for folder notes, including all subfolders. ```yaml BC-folder-note-recurse: true ``` -------------------------------- ### Linting and Formatting Commands Source: https://github.com/skepticmystic/breadcrumbs/blob/master/CONTRIBUTING.md Commands for linting code with ESLint and Rust's clippy, and formatting code with Prettier and Rust's fmt. ```bash bun run lint # ESLint + cargo clippy ``` ```bash bun run fmt # Prettier + cargo fmt ``` -------------------------------- ### Graph Engine Build Commands Source: https://github.com/skepticmystic/breadcrumbs/blob/master/CONTRIBUTING.md Commands to rebuild the Rust/WASM graph engine, with options for release and debug builds. ```bash bun run wasm:build # release build ``` ```bash bun run wasm:dev # debug build (faster, larger output) ``` -------------------------------- ### Release Commands Source: https://github.com/skepticmystic/breadcrumbs/blob/master/CONTRIBUTING.md Commands for maintainers to release beta or stable versions of the plugin. ```bash bun run release:beta # bump + tag + push beta ``` ```bash bun run release # bump + tag + push stable ``` -------------------------------- ### Transitive Relation Syntax Source: https://github.com/skepticmystic/breadcrumbs/wiki/Implied Edge Builders Demonstrates the general syntax for defining custom transitive relations, where a chain of fields collapses into a single closing field. ```plaintext [parent, parent] -> grandparent ``` ```plaintext [spouse, sibling] -> sibling-in-law ``` -------------------------------- ### Linting Command Source: https://github.com/skepticmystic/breadcrumbs/blob/master/AGENTS.md Command to run ESLint for linting the project. ```bash bun run lint ``` -------------------------------- ### Regex Note Flags Configuration Source: https://github.com/skepticmystic/breadcrumbs/wiki/Explicit Edge Builders Optional configuration to add flags (global, case-insensitive, multi-line) to the regex used in Regex Notes. ```yaml BC-regex-note-flags: ``` -------------------------------- ### Folder Note Frontmatter Source: https://github.com/skepticmystic/breadcrumbs/wiki/Explicit Edge Builders Frontmatter configuration to enable folder notes and specify the field for edges. ```yaml BC-folder-note-field: ``` -------------------------------- ### Regex Note Configuration Source: https://github.com/skepticmystic/breadcrumbs/wiki/Explicit Edge Builders Configuration for turning a note into a regex note, specifying the regex pattern and the field to use for the edge. ```yaml BC-regex-note-regex: BC-regex-note-field: ``` -------------------------------- ### Accessing the Breadcrumbs API Source: https://github.com/skepticmystic/breadcrumbs/wiki/API This snippet shows how to access the Breadcrumbs API from the window object. ```javascript window.BCAPI; ``` -------------------------------- ### Dataview Note Frontmatter Source: https://github.com/skepticmystic/breadcrumbs/wiki/Explicit Edge Builders Frontmatter configuration to enable Dataview notes and specify the query and field for edges. ```yaml BC-dataview-note-query: BC-dataview-note-field: ``` -------------------------------- ### Tag Note Exact Match Configuration Source: https://github.com/skepticmystic/breadcrumbs/wiki/Explicit Edge Builders Optional configuration to ensure edges are only added to notes that exactly match the specified tag. ```yaml BC-tag-note-exact: true ``` -------------------------------- ### Testing Commands Source: https://github.com/skepticmystic/breadcrumbs/blob/master/AGENTS.md Commands for running tests in the Breadcrumbs Obsidian plugin. ```bash bun run test # all vitest tests bun run test tests/path/to/file.test.ts # single file bun run wasm:test # Rust tests ``` -------------------------------- ### Development Commands Source: https://github.com/skepticmystic/breadcrumbs/blob/master/AGENTS.md Commands for developing the Breadcrumbs Obsidian plugin. ```bash bun run dev # watch TypeScript + CSS in parallel bun run build # type-check, svelte-check, bundle (production) bun run test # vitest bun run lint # ESLint (src/) + cargo clippy bun run fmt # prettier (src/) + cargo fmt bun run tsc -noEmit -skipLibCheck # type-check only # WASM — run after any Rust change bun run wasm:build # release build bun run wasm:dev # debug build (faster, larger) bun run wasm:test # Rust unit tests ``` -------------------------------- ### List Note Configuration Source: https://github.com/skepticmystic/breadcrumbs/wiki/Explicit Edge Builders Configuration for turning a note into a list note, specifying the field to use for the edge. ```yaml BC-list-note-field: ``` -------------------------------- ### Tag Note Configuration Source: https://github.com/skepticmystic/breadcrumbs/wiki/Explicit Edge Builders Configuration for turning a note into a tag note, specifying the tag and the field to use for the edge. ```yaml BC-tag-note-tag: "#tag" BC-tag-note-field: ``` -------------------------------- ### Same Sibling Relation Source: https://github.com/skepticmystic/breadcrumbs/wiki/Implied Edge Builders Illustrates the rule for identifying siblings when notes share the same parent. ```plaintext [same, same] -> same ``` -------------------------------- ### Style the Active Note in the Matrix View Source: https://github.com/skepticmystic/breadcrumbs/wiki/Styling If you have the setting `Treat Current Note as Implied Sibling` enabled, the current note will _always_ appear in the Matrix View. Use this snippet to style it differently. ```css .BC-active-note div { color: var(--text-normal); } ``` -------------------------------- ### Change Numbered List Items in Matrix View to Bullets Source: https://github.com/skepticmystic/breadcrumbs/wiki/Styling Using this snippet will make the markers in the Matrix View into bullets instead. ```css .BC-Matrix li { list-style: disc; } ``` -------------------------------- ### Remove all Buttons in the Matrix View Source: https://github.com/skepticmystic/breadcrumbs/wiki/Styling If you don't use any of the buttons in the Matrix View, use this snippet to hide them. ```css .workspace-leaf-content[data-type="BC-matrix"] .view-content button { display: none; } ``` -------------------------------- ### Parents Child Relation Source: https://github.com/skepticmystic/breadcrumbs/wiki/Implied Edge Builders Explains that if two notes share the same parent, they are considered siblings. ```plaintext [up, down] -> same ``` -------------------------------- ### Hide All/Shortest Button in Trail View Source: https://github.com/skepticmystic/breadcrumbs/wiki/Styling If you have the Trail View showing, you can use this snippet to hide the `All/Shortest` button if you never intend to use it. ```css .BC-trail button.button-div { display: none; } ``` -------------------------------- ### Align the Items in the Matrix View to the Left Source: https://github.com/skepticmystic/breadcrumbs/wiki/Styling Aligns the items in the Matrix View to the left and removes the border. ```css .BC-Matrix-square { text-align: left; border: 0; } ``` -------------------------------- ### Cousin Relation Source: https://github.com/skepticmystic/breadcrumbs/wiki/Implied Edge Builders Illustrates that cousins are also considered siblings. ```plaintext [up, same, down] -> same ``` -------------------------------- ### Opposite Direction Mapping Source: https://github.com/skepticmystic/breadcrumbs/wiki/Implied Edge Builders Provides the mapping for opposite direction implied relations. ```plaintext up -> down ``` ```plaintext down -> up ``` ```plaintext same -> same ``` ```plaintext prev -> next ``` ```plaintext next -> prev ``` -------------------------------- ### Hide Numbered List Items in Matrix View Entirely Source: https://github.com/skepticmystic/breadcrumbs/wiki/Styling This snippet will hide the numbering on items in the Matrix View. ```css .BC-Matrix ol > li::marker { content: ""; } .view-content .BC-Matrix .BC-Matrix-square ol { padding-left: 0; } ``` -------------------------------- ### Siblings Parent Relation Source: https://github.com/skepticmystic/breadcrumbs/wiki/Implied Edge Builders Shows how the parent of one sibling is also considered the parent of another sibling. ```plaintext [same, up] -> up ``` -------------------------------- ### Parents Sibling Relation Source: https://github.com/skepticmystic/breadcrumbs/wiki/Implied Edge Builders Defines the relationship where a parent's sibling is also considered a parent. ```plaintext [up, same] -> up ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.