mirror of
https://github.com/danielmiessler/Fabric.git
synced 2026-01-09 14:28:01 -05:00
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
This commit is contained in:
Kayvan Sylvan
3
.vscode/settings.json
vendored
3
.vscode/settings.json
vendored
@@ -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"
|
||||
]
|
||||
},
|
||||
|
||||
99
README.md
99
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)
|
||||
|
||||
<br />
|
||||
|
||||
|
||||
@@ -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 <http://localhost:3456>)
|
||||
|
||||
### 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.
|
||||
Refer to the [Contributing Guide](/docs/CONTRIBUTING.md) for details on how to improve this content.
|
||||
|
||||
Reference in New Issue
Block a user