Markshift

This is an yet another markup language, makeshift markshift.

Please see this video (at 2x speed):

Features

• Simple markup syntax with \t and []
  • heavily inspired by Scrapbox
• Zettelkasten (dynamic wiki links) first, powered by Markshift Language Server.
• Vim plugin included.
• Zotero integration.

Syntax

Hello world.
	create a list with a hard tab `\t'
		which can be nested
	the second element
	the third element
	[@quote]
		quoted text must be indented with '\t'

Decoration:
	[* bold text]
	[/ italic text]
	[*/ bold italic text]

Links:
	[wikilink]
	[https://google.com url title]
	[url title https://google.com]
	[@img https://via.placeholder.com/50 width=300 height=300]

Code highlight with highlight.js
	[@code python]
		import numpy as np
		print(np.sum(10))
	[` inline code `]

Math with katex
	[@math]
		O(n^2)\\
		sum_{i=0}^{10}{i} = 55
	inline math: [$ O(n log(n)) $]

installation

Python >=3.9 is required.

git clone https://github.com/ompugao/markshift
cd markshift/src/markshift/langserver
npm install
npm run frontend:prod
cd -
pip3 install -e markshift[languageserver]

console app

cd markshift
markshift_cli sample/input.ms --renderer markdown # or html

Zettelkasten with Markshift Language Server (msls)

• Setup Markshift Language Server (msls) with your client
  • binaries are available from https://github.com/ompugao/markshift/releases
• vim-lsp is required.
  • this forked version needs to be used to enable cliclable wikilink until it is merged: prabirshrestha/vim-lsp#1390

function! s:setup_markshift() abort
    let s:msls_client_id = lsp#register_server({
        \ 'name': 'msls',
        \ 'cmd': ['msls', '--never_steal_focus', '--always_on_top', '--zotero_path=~/Zotero'],
        \ 'allowlist': ['markshift'],
        \ })
        "or:
        "\ 'cmd': ['python3', '-m', 'markshift.langserver.server'],
endfunction

augroup vim-lsp-msls
  au!
  au User lsp_setup call s:setup_markshift()
augroup END