You can quickly get started with the in-broswer memodify. Please visit
https://memodify.appYou will see an alert at left-bottom and you can import a sample data set there by clicking a button to import. The data set has some notes, labels and roles as a manual and samples.
It's easy to start using memodify with private bwowsing/incognito mode because the imported data has gone when you close the window.
MDX allows you to use JSX in your markdown content. You can define your components in your notes.
Memodify also has builtin components which support Chart.js and Mermaid. You can easily embed charts and diagrams into your notes.
You can embed a few types of charts supported by Charts.js. Now Bar, Line and Scatter charts are supported as builtin component.
export const width = 256*1.414;
export const height = 256;
export const style = { backgroundColor: "white", padding: "0 4px" }
export const options = {
responsive: false,
maintainAspectRatio: false,
plugins: {
legend: { position: "bottom" },
title: { display: true, text: "Chart.js chart" },
},
}
export const labels = ["January", "February", "March", "April", "May", "June", "July"];
export const barData = {
labels,
datasets: [
{
label: "Dataset 1",
data: labels.map(() => Math.random() * 100),
backgroundColor: "rgba(255, 99, 132, 0.5)",
},
{
label: "Dataset 2",
data: labels.map(() => Math.random() * 100),
backgroundColor: "rgba(53, 162, 235, 0.5)",
},
],
};
<chartjs.Bar style={style} width={width} height={height} options={options} data={barData} />
You can embed diagrams supported by Mermaid.
Caution When using MDX feature in Memodify, it is important to only use content from trusted sources. MDX can potentially execute malicious code, known as self-XSS, which can compromise your device's security. I recommend only using MDX with content that you have personally created or obtained from a trusted source. Use this feature at your own risk, and always be vigilant when inputting or importing content into the MDX editor.
You can use KaTeX to render math expressions.
Syntax highlighting is supported with Prism. Lots of languages are recognized. Here is the supported languages.
```javascript
function main() {
console.log("hello, world.");
}
```
```yaml
name: Run a workflow
on:
push:
branches:
- master
- release/[0-9]+\.[0-9]+
env:
SLACK_CHANNEL: general
```
You can use command palette with command + shift + p.
You can focus on a note with note palette. It's activated with command + p.
It's supported to encrypt the focused note body.
crypto:encrypt note body opens a dialog and you can enter a passphrase.
It converts the body to a JSON object like this.
{
"ciphertext": "dtsLElgKr9p4r5L8xZoiOw==",
"iv": "5aL3VtMJsSRjrYaJ",
"salt": "jOV7M/sQcJaxIB3xj+uaYw=="
}
crypto:decrypt note body decrypt it.
Note Currenly the preview shows an error like this
because {...} is recognized as an MDX expression. I'm going to suppress this in the future.
2:15 Could not parse expression with acorn: Unexpected content after expression
You can open a pomodoro dialog with pomodoro:open dialog palette command.
Start, pause and cancel the timer with the buttons.
Succeeded and canceled pomodoros are recorded for a day.
You can put a configuration file to give some values like secrets to the Memodify application.
~/.config/memodify/config.yaml
vault:
# Given by APP_PATH_ROOT or VAULT_DIRECTORY.
# macOS: userData path: "~/Library/Application Support/memodify" by default.
directory: "~/.memodify/vault"
github:
# https://github.com/settings/tokens
token: "ghp_************************************"
openai:
# https://platform.openai.com/account/api-keys
api_key: "sk-************************************************"
| Item | Description |
|---|---|
github.token | Used to retrieve issue title in private repositories. |
openai.api_key | Used for ChatGPT feature. This blog entry is for an experimental feature for ChatGPT. |
Memodify allows you to save your data as a JSON file and load it.
file:savefile:loadfile:save opens a dialog then you can save your all documents as a new file
or replace an existing file.
file:load also opens a dialog and you can choose a file to be loaded.
Please note the format of saved JSON files is not stable and no data conversion is supported for now.
You can backup your data into CouchDB and restore it from there.
Go to Settings -> Datbase: CouchDB URL.
Input http://admin:password@localhost:5984/memodify.
$ docker run \
-e COUCHDB_USER=admin \
-e COUCHDB_PASSWORD=password \
-p 5984:5984 \
-v `pwd`/couchdb:/opt/couchdb/data \
couchdb:3.3.1
$ npx add-cors-to-couchdb http://admin:password@localhost:5984
Then you can backup your all documnets for memodify.
Open the command palette with Shift + command + P, then select file:backup.
Please note memodify doesn't resolve conflicts automatically. You have to resolve them by yourself. In order to do that, you can use CouchDB admin console. It's http://localhost:5984/_utils if your CouchDB is running at your own host.
:.memodify://.APP_PATH_ROOT: root path for the data directory.TBD