Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Feel-ix-343 committed Aug 9, 2024
1 parent 6475274 commit 570144f
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 24 deletions.
2 changes: 1 addition & 1 deletion docs/Markdown Oxide Docs/.obsidian/app.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"vimMode": false,
"vimMode": true,
"defaultViewMode": "source",
"livePreview": true,
"showInlineTitle": false
Expand Down
31 changes: 14 additions & 17 deletions docs/Markdown Oxide Docs/.obsidian/workspace.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@
"type": "split",
"children": [
{
"id": "acfea0793806610c",
"id": "a1434b6d6d5c0882",
"type": "tabs",
"children": [
{
"id": "1648e4973359b587",
"id": "d695463100ad962a",
"type": "leaf",
"state": {
"type": "markdown",
"state": {
"file": "Felix Zeller.md",
"file": "v0/Articles/Markdown-Oxide v0.md",
"mode": "preview",
"backlinks": true,
"source": false
Expand Down Expand Up @@ -66,13 +66,11 @@
"state": {}
}
}
],
"currentTab": 1
]
}
],
"direction": "horizontal",
"width": 200,
"collapsed": true
"width": 200
},
"right": {
"id": "63aba346fd695768",
Expand All @@ -88,7 +86,7 @@
"state": {
"type": "backlink",
"state": {
"file": "Felix Zeller.md",
"file": "v0/Articles/Markdown-Oxide v0.md",
"collapseAll": false,
"extraContext": false,
"sortOrder": "alphabetical",
Expand All @@ -105,7 +103,7 @@
"state": {
"type": "outgoing-link",
"state": {
"file": "Felix Zeller.md",
"file": "v0/Articles/Markdown-Oxide v0.md",
"linksCollapsed": false,
"unlinkedCollapsed": true
}
Expand All @@ -128,7 +126,7 @@
"state": {
"type": "outline",
"state": {
"file": "Felix Zeller.md"
"file": "v0/Articles/Markdown-Oxide v0.md"
}
}
}
Expand All @@ -150,12 +148,16 @@
"publish:Publish changes...": false
}
},
"active": "1648e4973359b587",
"active": "d695463100ad962a",
"lastOpenFiles": [
"What Is Markdown-Oxide.md",
"v0/Articles/Markdown-Oxide v0.md",
"Home.md",
"Index.md",
"Felix Zeller.md",
"Index.md~",
"Home.md~",
"Felix Zeller.md~",
"Home.md",
"Block Queries for Linking.md~",
"v0/References/v0 Features Reference.md~",
"Daily Notes.md~",
Expand All @@ -164,17 +166,12 @@
"README.md~",
"v0/References/v0 Features Reference.md",
"v0/Guides/Getting started with Markdown Oxide Version 0.md",
"v0/Articles/Markdown-Oxide v0.md",
"publish.css",
"Felix Zeller.md",
"v0/References/v0 Configuration Reference.md",
"Daily Notes.md",
"v0/Articles/Markdown-Oxide v0.md~",
"v0/Guides/v0 Getting Started Guide.md",
"Setup.md",
"What Is Markdown-Oxide.md",
"Personal Knowledge Management System.md",
"Index.md",
"Block Queries for Linking.md",
"Documentation Notes.md",
"Felix.md",
Expand Down
4 changes: 3 additions & 1 deletion docs/Markdown Oxide Docs/What Is Markdown-Oxide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@

- ^whatIsMarkdownOxide

Markdown-Oxide is an unbundled [[Personal Knowledge Management System|PKM]] that composes with your favorite text-editor. It allows you to construct a system of the *right tools* for the job of developing and using your knowledge.
Markdown-Oxide is a [[Personal Knowledge Management System|Personal Knowledge Management System(PKM)]] that composes with your favorite text-editor through the [Language Server Protocol(LSP)](https://microsoft.github.io/language-server-protocol/).

While other PKMs implement their own text-editors, markdown-oxide is *unbundled*: it leaves text-editing to a dedicated text-editor and focuses solely on robust, performant knowledge management.
7 changes: 2 additions & 5 deletions docs/Markdown Oxide Docs/v0/Articles/Markdown-Oxide v0.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

![[What Is Markdown-Oxide#^whatIsMarkdownOxide]]

It is implemented as a language server for the [Language Server Protocol(LSP)](https://microsoft.github.io/language-server-protocol/), allowing for various PKM workflows in popular text editors. It also is inspired by and highly compatible with Obsidian.
It also is inspired by and highly compatible with Obsidian.

> [!note] Editor Support
> The best-supported text editor is Neovim, but also popular with users are VSCode, Helix, and Zed.
Expand All @@ -13,12 +13,9 @@ It is implemented as a language server for the [Language Server Protocol(LSP)](h
Markdown-oxide is for you if...
- You have a favorite text editor -- possibly one that you have spent days configuring and cannot live without -- and it supports the LSP.
- For example, I started using Neovim when I first started programming. Now, I would not choose to use anything else to write text.
- Your set of Personal Knowledge Management needs can be met by Markdown-oxide.

In this article, I give an overview of the features Markdown-oxide so that you can decide if it is for you.

If you do decide you want to use it, there is a linked guide to help you set up and get comfortable with Markdown-oxide.
In this article, I give an overview of the features Markdown-oxide so that you can decide if it is for you. If you do decide you want to use it, there is a linked guide to help you set up and get comfortable with Markdown-oxide.

# PKM Features

Expand Down

0 comments on commit 570144f

Please sign in to comment.