Skip to content

Commit f964382

Browse files
committed
Clarify and extend docs
1 parent f38f5e1 commit f964382

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1212
### Added
1313

1414
- Support for transclusion / embeds of whole markdown files, headings and blocks, both in your user sections and in the system prompt
15+
- Optionally configure system prompt files via the frontmatter variable `aicmd-system-prompt-file` which follows the same rules as the plugin config. E.g. `aicmd-system-prompt-file: prompts/system prompt for programming.md`
1516

1617
### Fixed
1718

README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,18 @@ It can be configured via the Obsidian plugin settings to use any OpenAI-compatib
1515
- [Desktop first demo](https://youtu.be/_079Pi6UvgM?si=AJlnYs55XfYc4E5T)
1616
- [iPhone first demo](https://youtu.be/ZkXqeaQJAFw?si=Bbj_Wnf8F_Sy714O)
1717

18-
## Screenshots
18+
## Screenshots and examples
1919

2020
Please go to the dedicated [screenshots page](./screenshots/screenshots.md)
2121

22+
## Features
23+
24+
- Multiple branching chats as nested headings anywhere in your notes, see [nesting example](./docs/example_nesting.md)
25+
- Optionally configure different AI models for each markdown file via the frontmatter, in addition to the conventional plugin config
26+
- Use markdown files as system prompts. Use this for example to build up a library of system prompts for different applications.
27+
- Optionally configure a different system prompt file for each note via the frontmatter, e.g. `aicmd-system-prompt-file: ai-chats/system prompt productivity.md`
28+
- Use Obsidian embeds to construct modular and dynamic system prompts, see [screenshots](./screenshots/screenshots.md)
29+
2230
## Quickstart
2331

2432
- [Install plugin via community plugins](https://obsidian.md/plugins?id=ai-chat-as-md)

screenshots/screenshots.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# AI Chat as Markdown screenshots
22

3-
## Use markdown files as system prompts
3+
## Markdown files as system prompts
44

55
Here we've added a special "Memories and facts" section to the system prompt markdown file:
66

77
![Screenshot showing file as system prompt with memories](./obsidian-ai-chat-as-md-file-as-system-prompt.png)
88

99
Please see the [example system prompt markdown file](./docs/example_system_prompt.md).
1010

11-
## Obsidian embeds / transclusion for modular system prompts
11+
## Modular system prompts
1212

1313
Since the 1.5.0 version of the plugin, it supports one level of transclusion / embeds (`![[my other file]]` in obsidian) in your conversations, but also in your system prompt files!
1414

0 commit comments

Comments
 (0)