Fixes in docsite

synw · Jan 16, 2025 · d05add0 · d05add0
1 parent 74040ee
commit d05add0
Show file tree

Hide file tree

Showing 61 changed files with 236 additions and 55 deletions.
diff --git a/docs/.github/workflows/static.yml b/docs/.github/workflows/static.yml
diff --git a/docs/404.html b/docs/404.html
@@ -0,0 +1 @@
+index.html
diff --git a/docs/assets/_...all_-C3x79h6Y.js b/docs/assets/_...all_-C3x79h6Y.js
diff --git a/docs/assets/index-3CUBbFRZ.css b/docs/assets/index-3CUBbFRZ.css
diff --git a/docs/assets/index-Ch5I8FZ2.js b/docs/assets/index-Ch5I8FZ2.js
diff --git a/docs/assets/material-darker-B8DhjHfw.css b/docs/assets/material-darker-B8DhjHfw.css
diff --git a/docs/assets/stackoverflow-light-BBYOBnBl.css b/docs/assets/stackoverflow-light-BBYOBnBl.css
@@ -0,0 +1,13 @@
+pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}/*!
+  Theme: StackOverflow Light
+  Description: Light theme as used on stackoverflow.com
+  Author: stackoverflow.com
+  Maintainer: @Hirse
+  Website: https://github.com/StackExchange/Stacks
+  License: MIT
+  Updated: 2021-05-15
+
+  Updated for @stackoverflow/stacks v0.64.0
+  Code Blocks: /blob/v0.64.0/lib/css/components/_stacks-code-blocks.less
+  Colors: /blob/v0.64.0/lib/css/exports/_stacks-constants-colors.less
+*/.hljs{color:#2f3337;background:#f6f6f6}.hljs-subst{color:#2f3337}.hljs-comment{color:#656e77}.hljs-keyword,.hljs-selector-tag,.hljs-meta .hljs-keyword,.hljs-doctag,.hljs-section,.hljs-attr{color:#015692}.hljs-attribute{color:#803378}.hljs-name,.hljs-type,.hljs-number,.hljs-selector-id,.hljs-quote,.hljs-template-tag{color:#b75501}.hljs-selector-class{color:#015692}.hljs-string,.hljs-regexp,.hljs-symbol,.hljs-variable,.hljs-template-variable,.hljs-link,.hljs-selector-attr{color:#54790d}.hljs-meta,.hljs-selector-pseudo{color:#015692}.hljs-built_in,.hljs-title,.hljs-literal{color:#b75501}.hljs-bullet,.hljs-code{color:#535a60}.hljs-meta .hljs-string{color:#54790d}.hljs-deletion{color:#c02d2e}.hljs-addition{color:#2f6f44}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:700}
diff --git a/docs/assets/templates-C3s1MHtz.js b/docs/assets/templates-C3s1MHtz.js
diff --git a/docs/assets/templates-DzkHlK4t.css b/docs/assets/templates-DzkHlK4t.css
@@ -0,0 +1 @@
+.code-exec-btn svg{display:inline!important}
diff --git a/docs/public/doc/1.install.md → docs/doc/1.install.md b/docs/public/doc/1.install.md → docs/doc/1.install.md
diff --git a/docs/public/doc/2.usage.md → docs/doc/2.usage.md b/docs/public/doc/2.usage.md → docs/doc/2.usage.md
diff --git a/docs/public/doc/3.templates.cmp → docs/doc/3.templates.cmp b/docs/public/doc/3.templates.cmp → docs/doc/3.templates.cmp
diff --git a/docs/public/doc/nav.json → docs/doc/nav.json b/docs/public/doc/nav.json → docs/doc/nav.json
diff --git a/docs/public/favicon.ico → docs/favicon.ico b/docs/public/favicon.ico → docs/favicon.ico
diff --git a/docs/index.html b/docs/index.html
@@ -3,14 +3,15 @@
 
   <head>
     <meta charset="UTF-8" />
-    <link rel="icon" href="/favicon.ico" />
+    <link rel="icon" href="/modprompt/favicon.ico" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Doc</title>
+    <script type="module" crossorigin src="/modprompt/assets/index-Ch5I8FZ2.js"></script>
+    <link rel="stylesheet" crossorigin href="/modprompt/assets/index-3CUBbFRZ.css">
   </head>
 
   <body>
     <div id="app" class="min-h-screen min-w-screen background"></div>
-    <script type="module" src="/src/main.ts"></script>
   </body>
 
 </html>
diff --git a/docs/.nojekyll → docsite/.nojekyll b/docs/.nojekyll → docsite/.nojekyll
diff --git a/docs/LICENSE → docsite/LICENSE b/docs/LICENSE → docsite/LICENSE
diff --git a/docs/apidoc/.nojekyll → docsite/apidoc/.nojekyll b/docs/apidoc/.nojekyll → docsite/apidoc/.nojekyll
diff --git a/docs/apidoc/assets/highlight.css → docsite/apidoc/assets/highlight.css b/docs/apidoc/assets/highlight.css → docsite/apidoc/assets/highlight.css
diff --git a/docs/apidoc/assets/main.js → docsite/apidoc/assets/main.js b/docs/apidoc/assets/main.js → docsite/apidoc/assets/main.js
diff --git a/docs/apidoc/assets/navigation.js → docsite/apidoc/assets/navigation.js b/docs/apidoc/assets/navigation.js → docsite/apidoc/assets/navigation.js
diff --git a/docs/apidoc/assets/search.js → docsite/apidoc/assets/search.js b/docs/apidoc/assets/search.js → docsite/apidoc/assets/search.js
diff --git a/docs/apidoc/assets/style.css → docsite/apidoc/assets/style.css b/docs/apidoc/assets/style.css → docsite/apidoc/assets/style.css
diff --git a/docs/apidoc/classes/cls.PromptTemplate.html → ...te/apidoc/classes/cls.PromptTemplate.html b/docs/apidoc/classes/cls.PromptTemplate.html → ...te/apidoc/classes/cls.PromptTemplate.html
diff --git a/docs/apidoc/index.html → docsite/apidoc/index.html b/docs/apidoc/index.html → docsite/apidoc/index.html
diff --git a/...oc/interfaces/interfaces.HistoryTurn.html → ...oc/interfaces/interfaces.HistoryTurn.html b/...oc/interfaces/interfaces.HistoryTurn.html → ...oc/interfaces/interfaces.HistoryTurn.html
diff --git a/...apidoc/interfaces/interfaces.ImgData.html → ...apidoc/interfaces/interfaces.ImgData.html b/...apidoc/interfaces/interfaces.ImgData.html → ...apidoc/interfaces/interfaces.ImgData.html
diff --git a/...doc/interfaces/interfaces.LmTemplate.html → ...doc/interfaces/interfaces.LmTemplate.html b/...doc/interfaces/interfaces.LmTemplate.html → ...doc/interfaces/interfaces.LmTemplate.html
diff --git a/...oc/interfaces/interfaces.PromptBlock.html → ...oc/interfaces/interfaces.PromptBlock.html b/...oc/interfaces/interfaces.PromptBlock.html → ...oc/interfaces/interfaces.PromptBlock.html
diff --git a/...c/interfaces/interfaces.SpacingSlots.html → ...c/interfaces/interfaces.SpacingSlots.html b/...c/interfaces/interfaces.SpacingSlots.html → ...c/interfaces/interfaces.SpacingSlots.html
diff --git a/...idoc/interfaces/interfaces.TurnBlock.html → ...idoc/interfaces/interfaces.TurnBlock.html b/...idoc/interfaces/interfaces.TurnBlock.html → ...idoc/interfaces/interfaces.TurnBlock.html
diff --git a/docs/apidoc/modules/cls.html → docsite/apidoc/modules/cls.html b/docs/apidoc/modules/cls.html → docsite/apidoc/modules/cls.html
diff --git a/docs/apidoc/modules/db.html → docsite/apidoc/modules/db.html b/docs/apidoc/modules/db.html → docsite/apidoc/modules/db.html
diff --git a/docs/apidoc/modules/interfaces.html → docsite/apidoc/modules/interfaces.html b/docs/apidoc/modules/interfaces.html → docsite/apidoc/modules/interfaces.html
diff --git a/docs/apidoc/variables/db.templates.html → docsite/apidoc/variables/db.templates.html b/docs/apidoc/variables/db.templates.html → docsite/apidoc/variables/db.templates.html
diff --git a/docs/cheatset.md → docsite/cheatset.md b/docs/cheatset.md → docsite/cheatset.md
diff --git a/docs/components.d.ts → docsite/components.d.ts b/docs/components.d.ts → docsite/components.d.ts
@@ -8,22 +8,12 @@ export {}
 declare module 'vue' {
   export interface GlobalComponents {
     DefaultSidebar: typeof import('./src/components/sidebars/DefaultSidebar.vue')['default']
-    DispatchRoutePy: typeof import('./src/components/python/DispatchRoutePy.vue')['default']
     'IEva:arrowBackOutline': typeof import('~icons/eva/arrow-back-outline')['default']
-    'IFa6Brands:github': typeof import('~icons/fa6-brands/github')['default']
     'IFaBrands:github': typeof import('~icons/fa-brands/github')['default']
     'IFaSolid:moon': typeof import('~icons/fa-solid/moon')['default']
     'IFaSolid:sun': typeof import('~icons/fa-solid/sun')['default']
-    'INoto:crocodile': typeof import('~icons/noto/crocodile')['default']
-    'IPh:caretDownBold': typeof import('~icons/ph/caret-down-bold')['default']
-    'IPh:caretRightBold': typeof import('~icons/ph/caret-right-bold')['default']
-    PythonSidebar: typeof import('./src/components/sidebars/PythonSidebar.vue')['default']
-    RenderMd: typeof import('./src/components/markdown/RenderMd.vue')['default']
-    RenderMdPy: typeof import('./src/components/python/RenderMdPy.vue')['default']
-    RenderPyDocstring: typeof import('./src/components/python/RenderPyDocstring.vue')['default']
     RouterLink: typeof import('vue-router')['RouterLink']
     RouterView: typeof import('vue-router')['RouterView']
-    StaticPyCodeBlock: typeof import('./src/components/python/StaticPyCodeBlock.vue')['default']
     TheHeader: typeof import('./src/components/TheHeader.vue')['default']
     TheSidebar: typeof import('./src/components/TheSidebar.vue')['default']
   }

diff --git a/docsite/index.html b/docsite/index.html
@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html lang="en">
+
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" href="/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Doc</title>
+  </head>
+
+  <body>
+    <div id="app" class="min-h-screen min-w-screen background"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+
+</html>
diff --git a/docs/package.json → docsite/package.json b/docs/package.json → docsite/package.json
@@ -4,6 +4,7 @@
   "private": true,
   "scripts": {
     "dev": "vite",
+    "build_to_gh": "vite build && rm -rf ../docs/* && mv ./dist/* ../docs && cd ../docs && ln -s index.html 404.html",
     "build": "vite build && cd ./dist && ln -s index.html 404.html",
     "preview": "vite build && vite preview",
     "wdoc": "node ./node_modules/@docdundee/docnav/bin/docnav.mjs",
@@ -44,4 +45,4 @@
     "vite-plugin-pages": "^0.32.3"
   },
   "type": "module"
-}
+}
diff --git a/docs/postcss.config.cjs → docsite/postcss.config.cjs b/docs/postcss.config.cjs → docsite/postcss.config.cjs
diff --git a/docsite/public/doc/1.install.md b/docsite/public/doc/1.install.md
@@ -0,0 +1,23 @@
+# Install
+
+```bash
+npm i modprompt
+```
+
+## Quickstart
+
+```ts
+import { templates, PromptTemplate } from "modprompt";
+
+console.log("Available templates:", Object.keys(templates));
+
+// load a template
+const tpl = new PromptTemplate("chatml");
+
+// render the template
+console.log(tpl.render());
+
+// render with a prompt
+const prompt = "List the planets of the solar system";
+console.log(tpl.prompt(prompt));
+```
diff --git a/docsite/public/doc/2.usage.md b/docsite/public/doc/2.usage.md
@@ -0,0 +1,84 @@
+# Usage
+
+## Initialization
+
+First, you need to create a new instance of `PromptTemplate`. You can do this by providing either the name of the template to load or an instance of `LmTemplate`.
+
+```typescript
+const tpl = new PromptTemplate('alpaca'); // Loads the 'alpaca' template
+```
+
+## Cloning Templates
+
+You can clone an existing `PromptTemplate` instance to create a new one with the same settings.
+
+```typescript
+const clonedTpl = tpl.cloneTo('chatml'); // Clones the current template to the 'chatml' template
+```
+
+## Converting to JSON
+
+You can convert the current `PromptTemplate` instance to a JSON object.
+
+```typescript
+const json = tpl.toJson();
+console.log(json);
+```
+
+## Manipulating System Blocks
+
+You can replace or append messages to the system block.
+
+```typescript
+tpl.replaceSystem('You are a javascript expert'); // Replaces the system block with a new message
+tpl.afterSystem('You are a javascript expert'); // Appends a message after the system block
+```
+
+## Manipulating Prompt Blocks
+
+You can replace the `{prompt}` placeholder in the user message with a new message.
+
+```typescript
+tpl.replacePrompt(fix this invalid json:\n\n```json\n{prompt}\n```);
+```
+
+## Adding Shots
+
+You can add new shots (user-assistant interactions) to the template.
+
+```typescript
+tpl.addShot('Is it raining?', 'No, it is sunny.'); // Adds a single shot
+```
+
+You can also add multiple shots at once.
+
+```typescript
+tpl.addShots([
+  { user: 'What is the weather like?', assistant: 'It is sunny today!' },
+  { user: 'What is the weather like tomorrow?', assistant: 'I am sorry, but I can\'t predict the future.' }
+]);
+```
+
+## Rendering Templates
+
+You can render the template into a string representation.
+
+```typescript
+const rendered = tpl.render();
+console.log(rendered);
+```
+
+You can also render the template with a specific message replacing the `{prompt}` placeholder.
+
+```typescript
+const prompted = tpl.prompt("list the planets in the solar system");
+console.log(prompted);
+```
+
+## Pushing to History
+
+You can push a turn into the history of the template.
+
+```typescript
+tpl.pushToHistory({ user: 'What is the weather like?', assistant: 'It is sunny today!' });
+```
diff --git a/docsite/public/doc/3.templates.cmp b/docsite/public/doc/3.templates.cmp
diff --git a/docsite/public/doc/nav.json b/docsite/public/doc/nav.json
@@ -0,0 +1,35 @@
+{
+    "name": "doc",
+    "children": [],
+    "title": "Doc",
+    "content": [
+        {
+            "name": "install",
+            "title": "Install",
+            "filename": "1.install.md",
+            "url": "/install",
+            "docpath": "/1.install.md",
+            "type": "markdown"
+        },
+        {
+            "name": "usage",
+            "title": "Usage",
+            "filename": "2.usage.md",
+            "url": "/usage",
+            "docpath": "/2.usage.md",
+            "type": "markdown"
+        },
+        {
+            "name": "templates",
+            "title": "Templates",
+            "filename": "3.templates.cmp",
+            "url": "/templates",
+            "docpath": "/3.templates.cmp",
+            "type": "component"
+        }
+    ],
+    "docstrings": [],
+    "url": "",
+    "has_md_index": false,
+    "docpath": ""
+}
diff --git a/docsite/public/favicon.ico b/docsite/public/favicon.ico
diff --git a/docs/src/App.vue → docsite/src/App.vue b/docs/src/App.vue → docsite/src/App.vue
diff --git a/docs/src/assets/index.css → docsite/src/assets/index.css b/docs/src/assets/index.css → docsite/src/assets/index.css
diff --git a/docs/src/components/TheHeader.vue → docsite/src/components/TheHeader.vue b/docs/src/components/TheHeader.vue → docsite/src/components/TheHeader.vue
diff --git a/docs/src/components/TheSidebar.vue → docsite/src/components/TheSidebar.vue b/docs/src/components/TheSidebar.vue → docsite/src/components/TheSidebar.vue
diff --git a/...rc/components/sidebars/DefaultSidebar.vue → ...rc/components/sidebars/DefaultSidebar.vue b/...rc/components/sidebars/DefaultSidebar.vue → ...rc/components/sidebars/DefaultSidebar.vue
diff --git a/docs/src/conf.ts → docsite/src/conf.ts b/docs/src/conf.ts → docsite/src/conf.ts
diff --git a/docs/src/env.d.ts → docsite/src/env.d.ts b/docs/src/env.d.ts → docsite/src/env.d.ts
diff --git a/docs/src/main.ts → docsite/src/main.ts b/docs/src/main.ts → docsite/src/main.ts
diff --git a/docs/src/pages/[...all].vue → docsite/src/pages/[...all].vue b/docs/src/pages/[...all].vue → docsite/src/pages/[...all].vue
diff --git a/docs/src/pages/index.vue → docsite/src/pages/index.vue b/docs/src/pages/index.vue → docsite/src/pages/index.vue
diff --git a/docs/src/pages/templates.vue → docsite/src/pages/templates.vue b/docs/src/pages/templates.vue → docsite/src/pages/templates.vue
diff --git a/docs/src/router.ts → docsite/src/router.ts b/docs/src/router.ts → docsite/src/router.ts
diff --git a/docs/src/state.ts → docsite/src/state.ts b/docs/src/state.ts → docsite/src/state.ts
diff --git a/docs/tailwind.config.cjs → docsite/tailwind.config.cjs b/docs/tailwind.config.cjs → docsite/tailwind.config.cjs
diff --git a/docs/tsconfig.json → docsite/tsconfig.json b/docs/tsconfig.json → docsite/tsconfig.json
diff --git a/docs/vite.config.ts → docsite/vite.config.ts b/docs/vite.config.ts → docsite/vite.config.ts