@promptbook/markdown-utils 0.94.0-5 → 0.94.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.
- package/README.md +6 -11
- package/esm/index.es.js +1 -1
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/version.d.ts +1 -1
- package/package.json +24 -1
- package/umd/index.umd.js +1 -1
- package/umd/index.umd.js.map +1 -1
package/README.md
CHANGED
|
@@ -25,10 +25,6 @@ Write AI applications using plain human language across multiple models and plat
|
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
|
|
28
|
-
<blockquote style="color: #ff8811">
|
|
29
|
-
<b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
|
|
30
|
-
</blockquote>
|
|
31
|
-
|
|
32
28
|
## 📦 Package `@promptbook/markdown-utils`
|
|
33
29
|
|
|
34
30
|
- Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
|
|
@@ -56,7 +52,7 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
|
|
|
56
52
|
|
|
57
53
|
## 🤍 The Book Abstract
|
|
58
54
|
|
|
59
|
-
**It's time for a paradigm shift! The future of software is in plain English, French or Latin.**
|
|
55
|
+
**It's time for a paradigm shift! The future of software is written in plain English, French, or Latin.**
|
|
60
56
|
|
|
61
57
|
During the computer revolution, we have seen [multiple generations of computer languages](https://github.com/webgptorg/promptbook/discussions/180), from the physical rewiring of the vacuum tubes through low-level machine code to the high-level languages like Python or JavaScript. And now, we're on the edge of the **next revolution**!
|
|
62
58
|
|
|
@@ -66,7 +62,7 @@ It's a revolution of writing software in **plain human language** that is unders
|
|
|
66
62
|
|
|
67
63
|
The incredible growth in power of microprocessors and the Moore's Law have been the driving force behind the ever-more powerful languages, and it's been an amazing journey! Similarly, the large language models (like GPT or Claude) are the next big thing in language technology, and they're set to transform the way we interact with computers.
|
|
68
64
|
|
|
69
|
-
This shift
|
|
65
|
+
This shift will happen whether we're ready or not. Our mission is to make it excellent, not just good.
|
|
70
66
|
|
|
71
67
|
**Join us in this journey!**
|
|
72
68
|
|
|
@@ -189,7 +185,6 @@ _A concise, Markdown-based DSL for crafting AI workflows and automations._
|
|
|
189
185
|
|
|
190
186
|
|
|
191
187
|
|
|
192
|
-
|
|
193
188
|
### Introduction
|
|
194
189
|
|
|
195
190
|
Book is a Markdown-based language that simplifies the creation of AI applications, workflows, and automations. With human-readable commands, you can define inputs, outputs, personas, knowledge sources, and actions—without needing model-specific details.
|
|
@@ -217,7 +212,7 @@ Book is a Markdown-based language that simplifies the creation of AI application
|
|
|
217
212
|
→ {article}
|
|
218
213
|
```
|
|
219
214
|
|
|
220
|
-
Each part of the book defines one of
|
|
215
|
+
Each part of the book defines one of three circles:
|
|
221
216
|
|
|
222
217
|
### **1. What:** Workflows, Tasks and Parameters
|
|
223
218
|
|
|
@@ -255,9 +250,9 @@ The resources used by the personas are used to do the work.
|
|
|
255
250
|
|
|
256
251
|
Book language is based on markdown. It is subset of markdown. It is designed to be easy to read and write. It is designed to be understandable by both humans and machines and without specific knowledge of the language.
|
|
257
252
|
|
|
258
|
-
The file has `.book` extension
|
|
253
|
+
The file has a `.book` extension and uses UTF-8 encoding without BOM.
|
|
259
254
|
|
|
260
|
-
|
|
255
|
+
Books have two variants: flat — just a prompt without structure, and full — with tasks, commands, and prompts.
|
|
261
256
|
|
|
262
257
|
As it is source code, it can leverage all the features of version control systems like git and does not suffer from the problems of binary formats, proprietary formats, or no-code solutions.
|
|
263
258
|
|
|
@@ -338,7 +333,7 @@ The following glossary is used to clarify certain concepts:
|
|
|
338
333
|
- **Retrieval-augmented generation** is a machine learning paradigm where a model generates text by retrieving relevant information from a large database of text. This approach combines the benefits of generative models and retrieval models.
|
|
339
334
|
- **Longtail** refers to non-common or rare events, items, or entities that are not well-represented in the training data of machine learning models. Longtail items are often challenging for models to predict accurately.
|
|
340
335
|
|
|
341
|
-
_Note: This section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
|
|
336
|
+
_Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
|
|
342
337
|
|
|
343
338
|
|
|
344
339
|
|
package/esm/index.es.js
CHANGED
|
@@ -25,7 +25,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
|
|
|
25
25
|
* @generated
|
|
26
26
|
* @see https://github.com/webgptorg/promptbook
|
|
27
27
|
*/
|
|
28
|
-
const PROMPTBOOK_ENGINE_VERSION = '0.94.0
|
|
28
|
+
const PROMPTBOOK_ENGINE_VERSION = '0.94.0';
|
|
29
29
|
/**
|
|
30
30
|
* TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
|
|
31
31
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|