github/Fabric
1
1
Fork 0
mirror of https://github.com/danielmiessler/Fabric.git synced 2026-01-08 22:08:03 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: update table of contents with proper nesting and fix minor formatting issues

Browse Source 
## 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
2025-10-14 07:16:38 -07:00
parent cab77728da
commit 2bd0d6292f
3 changed files with 68 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
web/README.md
View File

@@ -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.