tocsify 3.0.0: llms.txt, llms-full.txt, and no runtime dependencies

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        node: ['22.13.0', '22.x', '24.x', '26.x']
+        include:
+          - os: windows-latest
+            node: '24.x'
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-node@v7
+        with:
+          node-version: ${{ matrix.node }}
+          cache: npm
+      - run: npm ci
+      - run: npm run lint
+      - run: npm test

.github/workflows/release.yml

@@ -0,0 +1,23 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-node@v7
+        with:
+          node-version: 24.x
+          package-manager-cache: false
+          registry-url: https://registry.npmjs.org
+      - run: npm ci
+      - run: npm test
+      - run: npm publish

.gitignore

@@ -33,11 +33,7 @@ jspm_packages
 # Editors
 .idea
 
-# Lib
-lib
-
 # npm package lock
-package-lock.json
 yarn.lock
 
 # others

.nvmrc

@@ -1 +1 @@
-v8.11.1
+22

CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+## 3.0.0
+
+### Breaking
+
+- Node `>=22.13.0`.
+- `llms.txt` and `llms-full.txt` are written by default. `--no-llm` turns them off.
+- A base URL is required unless tocsify can detect one.
+- Anchors in `toc.md` now use Docsify 5 ids. This changes links for headings with leading digits, accents, emoji, `:id=`, links, or `#`.
+- `-h` now means `--help` instead of `--header`.
+- `bin` and `main` move to `src/cli.js`. `lib/` is gone. `exports` blocks deep imports.
+- `dir` defaults to `docs`.
+
+### Fixes
+
+- The underscore skip rule.
+- Exact `README.md` and `index.md` matching.
+- Comment-form ignore markers.
+- Help text that said `--maxdepth` defaults to 3.
+- The demo loading Docsify 4.13.1.
+- Tests that asserted nothing.
+
+### Removed
+
+- Every runtime dependency. This clears the markdown-toc and meow audit findings.

README.md

@@ -1,53 +1,126 @@
-# 📋 tocsify
+# tocsify
 
 [![NPM version](https://img.shields.io/npm/v/tocsify.svg?style=flat)](https://www.npmjs.com/package/tocsify) [![NPM downloads](https://img.shields.io/npm/dm/tocsify.svg?style=flat)](https://npmjs.org/package/tocsify)
 
-📋 npm module that **generates a table of contents** based on the **file structure** of a [Docsify](https://docsify.js.org) `docs` directory!
+tocsify reads a Docsify 5 `docs` folder and writes three files:
 
-## Features
+- `docs/toc.md`, a table of contents
+- `docs/llms.txt`, an index for LLMs
+- `docs/llms-full.txt`, the full text of every page
 
-* Adds relative path to title in each top-level entry for context.
-* Skips markdown files beginning with `_`.
-* Allows users to specify `maxdepth` for cleaner generation.
-* Skips generation for headers marked `{docsify-ignore}`
-* If `{docsify-ignore-all}` exists in a top level header (`# Example Header {docsify-ignore-all}`), skip generating the table of contents for the entire document.
-
-## Installation
-
-Install globally for use in any [Docsify](https://docsify.js.org) project!
+## Install
 
 ```bash
 npm install -g tocsify
 ```
 
+Node.js `>=22.13.0` is required.
+
 ## Usage
 
-```bash
-  Usage
-    $ tocsify docs --file=docs/toc.md
-
-  Options
-    --verbose, -v   Write output to stdout.
-    --file, -f      Write output to file.
-    --header, -h    Include a descriptive header. Default is true.
-    --maxdepth, -m  Specify max level header(1 - 6) to output. Default is 3.
-
-  Examples
-    $ tocsify docs --file=docs/toc.md
-    $ tocsify docs --verbose --file=docs/toc.md
-    $ tocsify docs --maxdepth=2
-    $ tocsify docs --header=false
+```text
+Usage
+  $ tocsify [dir] [options]
+
+  dir defaults to docs.
+
+Options
+  --file, -f       Path of the table of contents. Default: docs/toc.md
+  --maxdepth, -m   Deepest heading level, 1 to 6. Default: 6
+  --no-header      Do not prefix page links with ###.
+  --verbose, -v    Also print the table of contents to stdout.
+  --no-llm         Do not write llms.txt and llms-full.txt.
+  --base-url       Site URL for links in the llms files. Detected if not set.
+  --title          Title for llms.txt. Default: H1 of the home page
+  --summary        Summary for llms.txt. Default: first paragraph of the home page
+  --group          h2 or sidebar. Default: h2
+  --keep-comments  Keep HTML comments in llms-full.txt.
+  --help, -h       Show this help.
+  --version        Show the version.
+
+Examples
+  $ tocsify docs
+  $ tocsify docs --maxdepth=2 --no-header
+  $ tocsify docs --base-url=https://example.com/docs/
+  $ tocsify docs --no-llm
+```
+
+`-h` means `--help`. It used to mean `--header`.
+
+## Base URL
+
+`llms.txt` and `llms-full.txt` use absolute links. tocsify picks the first hit:
+
+1. `--base-url`, which must start with `http://` or `https://`
+2. The first non-empty line of `<dir>/CNAME`
+3. `GITHUB_REPOSITORY`, as `https://owner.github.io/repo/`
+4. `git remote origin`, when it is a GitHub URL
+5. `homepage` in `package.json`
+
+Pass `--base-url` when the docs folder is not the GitHub Pages root. `--no-llm` skips this step and writes only `toc.md`.
+
+In `llms-full.txt`, each relative link becomes the URL Docsify 5 loads with its default `relativePath: false`. Markdown links, `<img src>`, and `<a href>` resolve from the docs root. Markdown images resolve from the page folder. A link that starts with `/` resolves from the base URL, which is the docs root.
+
+## GitHub Actions
+
+Run tocsify on push to `main`, then commit the three files when they change. A push made with `GITHUB_TOKEN` does not start another workflow run.
+
+```yaml
+name: Docs
+on:
+  push:
+    branches: [main]
+permissions:
+  contents: write
+jobs:
+  llms:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-node@v7
+        with:
+          node-version: 24.x
+      - run: npx tocsify@3 docs
+      - run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add docs/toc.md docs/llms.txt docs/llms-full.txt
+          git diff --cached --quiet || git commit -m "docs: update toc and llms files"
+          git push
+```
+
+## Docsify 5
+
+Put these two links in `<head>`:
+
+```html
+<link rel="alternate" type="text/markdown" href="llms.txt" title="llms.txt">
+<link rel="alternate" type="text/markdown" href="llms-full.txt" title="llms-full.txt">
 ```
 
-## Integration
+Put a `<noscript>` list in `<body>` that links `llms.txt`, `llms-full.txt`, and `toc.md`.
 
-Integration with a [Docsify](https://docsify.js.org) homepage is easy!
+Load Docsify 5 from `dist/`. The `lib/` folder in the docsify 5 package still holds the 4.13.1 build.
+
+```html
+<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@5/dist/themes/core.min.css">
+<script src="//cdn.jsdelivr.net/npm/docsify@5/dist/docsify.min.js"></script>
+```
 
-In `index.md` or `_sidebar.md`, paste the snippet below where the Table of Contents should appear:
+This include still works in Docsify 5:
 
 ```markdown
-## Table of Contents
 [filename](toc.md ':include')
 ```
 
-A working `index.md` file can be found in the docs directory [here](docs/index.md) for reference.
+Links in `toc.md` use the `guide/setup.md#id` form. Docsify 5 rewrites them when `relativePath` is false, which is the default. With `relativePath: true`, a `toc.md` included from a subfolder page breaks these links.
+
+## Skip rules
+
+A markdown file is a page when all of these hold:
+
+- The name ends in `.md`.
+- No folder or file name starts with `_` or `.`.
+- The base name is not exactly `README.md` or `index.md`.
+
+`{docsify-ignore}` leaves that heading out of `toc.md`. `{docsify-ignore-all}` leaves the page out. The comment forms `<!-- {docsify-ignore} -->` and `<!-- {docsify-ignore-all} -->` count too.

docs/index.html

@@ -4,17 +4,26 @@
     <meta charset="UTF-8">
     <title>@droxey/tocsify</title>
     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
-    <meta name="description" content="Generates a table of contents based on the structure of your docsify docs directory! Respects docsify syntax for ignoring headers, etc.">
+    <meta name="description" content="Generates a table of contents and llms.txt files from a Docsify docs directory.">
     <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
     <link rel="apple-touch-icon-precomposed" sizes="114x114" href="s3.outputs.io/img/icon/favicon/apple-touch-icon-114x114.png">
     <link rel="apple-touch-icon-precomposed" sizes="72x72" href="s3.outputs.io/img/icon/favicon/apple-touch-icon-72x72.png">
     <link rel="apple-touch-icon-precomposed" sizes="144x144" href="s3.outputs.io/img/icon/favicon/apple-touch-icon-144x144.png">
     <link rel="apple-touch-icon-precomposed" sizes="120x120" href="s3.outputs.io/img/icon/favicon/apple-touch-icon-120x120.png">
     <link rel="apple-touch-icon-precomposed" sizes="152x152" href="s3.outputs.io/img/icon/favicon/apple-touch-icon-152x152.png">
     <link rel="icon" type="image/png" href="//s3.outputs.io/img/icon/favicon/favicon-57x57.png" sizes="57x57">
-    <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
+    <link rel="alternate" type="text/markdown" href="llms.txt" title="llms.txt">
+    <link rel="alternate" type="text/markdown" href="llms-full.txt" title="llms-full.txt">
+    <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@5/dist/themes/core.min.css">
   </head>
   <body>
+    <noscript>
+      <ul>
+        <li><a href="llms.txt">llms.txt</a></li>
+        <li><a href="llms-full.txt">llms-full.txt</a></li>
+        <li><a href="toc.md">toc.md</a></li>
+      </ul>
+    </noscript>
     <div data-app id="app"></div>
     <script>
       window.$docsify = {
@@ -28,11 +37,9 @@
 
       var isDeployed = window.document.location.href.indexOf("droxey.com") !== -1;
       if (isDeployed) {
-        window.$docsify = {
-          basePath: "https://droxey.com/tocsify/"
-        };
+        window.$docsify.basePath = "https://droxey.com/tocsify/";
       }
     </script>
-    <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+    <script src="//cdn.jsdelivr.net/npm/docsify@5/dist/docsify.min.js"></script>
   </body>
 </html>