living-documentation 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. package/README.md +12 -13
  2. package/dist/src/frontend/admin.html +552 -232
  3. package/dist/src/frontend/index.html +9 -16
  4. package/dist/src/lib/config.d.ts +1 -0
  5. package/dist/src/lib/config.d.ts.map +1 -1
  6. package/dist/src/lib/config.js +1 -0
  7. package/dist/src/lib/config.js.map +1 -1
  8. package/dist/src/lib/parser.js +2 -2
  9. package/dist/src/lib/parser.js.map +1 -1
  10. package/dist/src/routes/browse.d.ts +3 -0
  11. package/dist/src/routes/browse.d.ts.map +1 -0
  12. package/dist/src/routes/browse.js +36 -0
  13. package/dist/src/routes/browse.js.map +1 -0
  14. package/dist/src/routes/config.d.ts.map +1 -1
  15. package/dist/src/routes/config.js +10 -0
  16. package/dist/src/routes/config.js.map +1 -1
  17. package/dist/src/routes/documents.d.ts.map +1 -1
  18. package/dist/src/routes/documents.js +56 -11
  19. package/dist/src/routes/documents.js.map +1 -1
  20. package/dist/src/server.d.ts.map +1 -1
  21. package/dist/src/server.js +2 -0
  22. package/dist/src/server.js.map +1 -1
  23. package/package.json +1 -1
package/README.md CHANGED
@@ -8,8 +8,6 @@ No cloud, no database, no build step — just point it at a folder of `.md` file
8
8
  ![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue)
9
9
  ![License](https://img.shields.io/badge/License-MIT-lightgrey)
10
10
 
11
- ---
12
-
13
11
  ## Features
14
12
 
15
13
  - **Sidebar** grouped by category, sorted by date (newest first)
@@ -91,13 +89,14 @@ Documents are parsed using this default pattern:
91
89
  YYYY_MM_DD_[Category]_title_words.md
92
90
  ```
93
91
 
94
- | Part | Example | Parsed as |
95
- |------|---------|-----------|
96
- | `2024_01_15` | `2024_01_15` | Date → Jan 15, 2024 |
97
- | `[DevOps]` | `[DevOps]` | Category → DevOps |
92
+ | Part | Example | Parsed as |
93
+ | ----------------- | ----------------- | ----------------------- |
94
+ | `2024_01_15` | `2024_01_15` | Date → Jan 15, 2024 |
95
+ | `[DevOps]` | `[DevOps]` | Category → DevOps |
98
96
  | `deploy_pipeline` | `deploy_pipeline` | Title → Deploy Pipeline |
99
97
 
100
98
  **Full example:**
99
+
101
100
  ```
102
101
  2024_01_15_[DevOps]_deploy_pipeline.md
103
102
  2024_03_20_[Frontend]_react_hooks_guide.md
@@ -153,13 +152,13 @@ living-documentation/
153
152
 
154
153
  ## API reference
155
154
 
156
- | Method | Endpoint | Description |
157
- |--------|----------|-------------|
158
- | `GET` | `/api/documents` | List all documents with metadata |
159
- | `GET` | `/api/documents/:id` | Get document content + rendered HTML |
160
- | `GET` | `/api/documents/search?q=` | Full-text search |
161
- | `GET` | `/api/config` | Read config |
162
- | `PUT` | `/api/config` | Update config (`title`, `theme`, `filenamePattern`) |
155
+ | Method | Endpoint | Description |
156
+ | ------ | -------------------------- | --------------------------------------------------- |
157
+ | `GET` | `/api/documents` | List all documents with metadata |
158
+ | `GET` | `/api/documents/:id` | Get document content + rendered HTML |
159
+ | `GET` | `/api/documents/search?q=` | Full-text search |
160
+ | `GET` | `/api/config` | Read config |
161
+ | `PUT` | `/api/config` | Update config (`title`, `theme`, `filenamePattern`) |
163
162
 
164
163
  ---
165
164