Skip to content

Latest commit

 

History

History
84 lines (67 loc) · 2.12 KB

README.md

File metadata and controls

84 lines (67 loc) · 2.12 KB
Raw

nextjs-obsidian-publish

alternative to Obsidian Publish

codename: Obsidian.md Pyrite Publisher

🎁 Features

  1. interactive node graph
  2. callout quote blocks
  3. markdown links (no support for wiki links)
  4. file tree navigation
  5. interactive table of contents
  6. markdown images (external and internally hosted)
  7. fuzzy site search

📷 Screenshots

pywriter-publisher-04 pywriter-publisher-03 pywriter-publisher-02 pywriter-publisher-01

⚙ Development Setup

  1. copy any notes into ./MarkdownVault/
  2. include file ./MarkdownVault/index.md
  3. npm i
  4. npm run init
  5. npm run dev

🏭 Production Setup

  1. copy any notes into ./MarkdownVault/
./MarkdownVault/
  - index.md
  - file1.md
  - file2.md
  * folderA/
    - fileA1.md
    - fileA2.md
  1. include a ./MarkdownVault/index.md that acts as the glossery of your notes
  2. if building with docker
  • docker compose up -d
  1. else
  • npm run init
  • npm run build

👇 Markdown Tips

create unique headers per page.
### Dogs 
### Cats ✔

Do not repeate same header on the same page
### Fish 
### Fish ❌ 

even if it's a smaller header
### Birds 
#### Birds ❌

Warning

don't use links/tags in headers. It will screw up the "Table of Contents" widget

do NOT use links in headers

## Clean Header ✔
## [bad header](https://www.windows93.net/) ❌

[!warning] all attachments in ./MarkdownVault/_attachments will all be publicly viewable

keep all attacments in `./MarkdownVault/_attachments/` directory

./MarkdownVault/_attachments/camel.jpg ✔
./MarkdownVault/_attachments/reptiles/lizard.jpg ❌

🌠 Wishlist

  • better functioning graph with Pixi.js
  • interactive tag system