From 2bd0d6292fdfa92a30567f7394b2f20746d6f415 Mon Sep 17 00:00:00 2001 From: Kayvan Sylvan Date: Tue, 14 Oct 2025 07:16:38 -0700 Subject: [PATCH] docs: update table of contents with proper nesting and fix minor formatting issues ## CHANGES - Add top-level project name to navigation hierarchy - Nest all sections under main project heading - Fix npm install script path extension - Update localhost URL to use HTML format - Add "Mdsvex" to VSCode spelling dictionary - Include "details" and "summary" to HTML tags - Remove trailing newline from web README --- .vscode/settings.json | 3 ++ README.md | 99 ++++++++++++++++++++++--------------------- web/README.md | 29 +++++++------ 3 files changed, 68 insertions(+), 63 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 4d01067b..6c7d8900 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -113,6 +113,7 @@ "matplotlib", "mattn", "mbed", + "Mdsvex", "metacharacters", "Miessler", "modeline", @@ -221,6 +222,7 @@ "a", "br", "code", + "details", "div", "em", "h", @@ -228,6 +230,7 @@ "img", "module", "p", + "summary", "sup" ] }, diff --git a/README.md b/README.md index 1de6b5bb..a812e1d6 100644 --- a/README.md +++ b/README.md @@ -128,55 +128,56 @@ Keep in mind that many of these were recorded when Fabric was Python-based, so r ## Navigation -- [What and why](#what-and-why) -- [Updates](#updates) - - [Recent Major Features](#recent-major-features) -- [Intro videos](#intro-videos) -- [Navigation](#navigation) -- [Changelog](#changelog) -- [Philosophy](#philosophy) - - [Breaking problems into components](#breaking-problems-into-components) - - [Too many prompts](#too-many-prompts) -- [Installation](#installation) - - [One-Line Install (Recommended)](#one-line-install-recommended) - - [Manual Binary Downloads](#manual-binary-downloads) - - [Using package managers](#using-package-managers) - - [macOS (Homebrew)](#macos-homebrew) - - [Arch Linux (AUR)](#arch-linux-aur) - - [Windows](#windows) - - [From Source](#from-source) - - [Docker](#docker) - - [Environment Variables](#environment-variables) - - [Setup](#setup) - - [Per-Pattern Model Mapping](#per-pattern-model-mapping) - - [Add aliases for all patterns](#add-aliases-for-all-patterns) - - [Save your files in markdown using aliases](#save-your-files-in-markdown-using-aliases) - - [Migration](#migration) - - [Upgrading](#upgrading) - - [Shell Completions](#shell-completions) - - [Quick install (no clone required)](#quick-install-no-clone-required) - - [Zsh Completion](#zsh-completion) - - [Bash Completion](#bash-completion) - - [Fish Completion](#fish-completion) -- [Usage](#usage) - - [Debug Levels](#debug-levels) -- [Our approach to prompting](#our-approach-to-prompting) -- [Examples](#examples) -- [Just use the Patterns](#just-use-the-patterns) - - [Prompt Strategies](#prompt-strategies) -- [Custom Patterns](#custom-patterns) - - [Setting Up Custom Patterns](#setting-up-custom-patterns) - - [Using Custom Patterns](#using-custom-patterns) - - [How It Works](#how-it-works) -- [Helper Apps](#helper-apps) - - [`to_pdf`](#to_pdf) - - [`to_pdf` Installation](#to_pdf-installation) - - [`code_helper`](#code_helper) -- [pbpaste](#pbpaste) -- [Web Interface (Fabric Web App)](#web-interface-fabric-web-app) -- [Meta](#meta) - - [Primary contributors](#primary-contributors) - - [Contributors](#contributors) +- [`fabric`](#fabric) + - [What and why](#what-and-why) + - [Updates](#updates) + - [Recent Major Features](#recent-major-features) + - [Intro videos](#intro-videos) + - [Navigation](#navigation) + - [Changelog](#changelog) + - [Philosophy](#philosophy) + - [Breaking problems into components](#breaking-problems-into-components) + - [Too many prompts](#too-many-prompts) + - [Installation](#installation) + - [One-Line Install (Recommended)](#one-line-install-recommended) + - [Manual Binary Downloads](#manual-binary-downloads) + - [Using package managers](#using-package-managers) + - [macOS (Homebrew)](#macos-homebrew) + - [Arch Linux (AUR)](#arch-linux-aur) + - [Windows](#windows) + - [From Source](#from-source) + - [Docker](#docker) + - [Environment Variables](#environment-variables) + - [Setup](#setup) + - [Per-Pattern Model Mapping](#per-pattern-model-mapping) + - [Add aliases for all patterns](#add-aliases-for-all-patterns) + - [Save your files in markdown using aliases](#save-your-files-in-markdown-using-aliases) + - [Migration](#migration) + - [Upgrading](#upgrading) + - [Shell Completions](#shell-completions) + - [Quick install (no clone required)](#quick-install-no-clone-required) + - [Zsh Completion](#zsh-completion) + - [Bash Completion](#bash-completion) + - [Fish Completion](#fish-completion) + - [Usage](#usage) + - [Debug Levels](#debug-levels) + - [Our approach to prompting](#our-approach-to-prompting) + - [Examples](#examples) + - [Just use the Patterns](#just-use-the-patterns) + - [Prompt Strategies](#prompt-strategies) + - [Custom Patterns](#custom-patterns) + - [Setting Up Custom Patterns](#setting-up-custom-patterns) + - [Using Custom Patterns](#using-custom-patterns) + - [How It Works](#how-it-works) + - [Helper Apps](#helper-apps) + - [`to_pdf`](#to_pdf) + - [`to_pdf` Installation](#to_pdf-installation) + - [`code_helper`](#code_helper) + - [pbpaste](#pbpaste) + - [Web Interface (Fabric Web App)](#web-interface-fabric-web-app) + - [Meta](#meta) + - [Primary contributors](#primary-contributors) + - [Contributors](#contributors)
diff --git a/web/README.md b/web/README.md index d1b6e8c8..8f1f077c 100644 --- a/web/README.md +++ b/web/README.md @@ -7,17 +7,18 @@ A user-friendly web interface for [Fabric](https://github.com/danielmiessler/Fab ## Table of Contents -- [Table of Contents](#table-of-contents) -- [Installation](#installation) -- [Running the App](#running-the-app) - - [Prerequisites](#prerequisites) - - [Launch the Svelte App](#launch-the-svelte-app) -- [Streamlit UI](#streamlit-ui) - - [Key Features](#key-features) - - [Setup and Run](#setup-and-run) -- [Obsidian Integration](#obsidian-integration) - - [Quick Setup](#quick-setup) -- [Contributing](#contributing) +- [Fabric Web App](#fabric-web-app) + - [Table of Contents](#table-of-contents) + - [Installation](#installation) + - [Running the App](#running-the-app) + - [Prerequisites](#prerequisites) + - [Launch the Svelte App](#launch-the-svelte-app) + - [Streamlit UI](#streamlit-ui) + - [Key Features](#key-features) + - [Setup and Run](#setup-and-run) + - [Obsidian Integration](#obsidian-integration) + - [Quick Setup](#quick-setup) + - [Contributing](#contributing) ## Installation @@ -29,7 +30,7 @@ From the Fabric root directory: **Using npm:** ```bash -./web/scripts/npm-install +./web/scripts/npm-install.sh ``` **Or using pnpm (recommended for speed):** @@ -50,7 +51,7 @@ Start Fabric's server in a separate terminal: fabric --serve ``` -(This exposes Fabric's API at http://localhost:3456) +(This exposes Fabric's API at ) ### Launch the Svelte App @@ -120,4 +121,4 @@ Turn `web/src/lib/content/` into an [Obsidian](https://obsidian.md) vault for no ## Contributing -Refer to the [Contributing Guide](/docs/CONTRIBUTING.md) for details on how to improve this content. \ No newline at end of file +Refer to the [Contributing Guide](/docs/CONTRIBUTING.md) for details on how to improve this content.