mirror/cadmus
1
0
Fork 0
mirror of https://github.com/RyanGreenup/cadmus.git synced 2025-01-29 10:20:25 +01:00
Code Issues Releases Wiki Activity

How to Preview

Browse Source
This commit is contained in:
ryangreenup 2020-07-24 21:04:45 +10:00
parent 24c5ab9e9f
commit 161d9fea65
1 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/preview.md Normal file
View File

@ -0,0 +1,30 @@
---
title: Preview
---
# Search
!!! note
Start this with `cadmus preview`
## What does it do
This starts [markserv](https://github.com/markserv/markserv) in the notes directory and prints a qr code to the terminal.
## How Do I use it
!!! warning
This requires markserv and qrencode.
Just run `cadmus preview` or `cadmus preview!` for global, to view your notes with makserv.
## When Would This Be Used
This is good for previewing your notes similar to what they might look like on *GitHub*, the global `preview!` can be good to read notes on an *iPad* or share with friends over the LAN (think on campus).
### Example
#TODO
## How does it Work
This just uses ordinary calls to `MarkServ`