Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wchorski/PyWrite-Publisher
alternative to Obsidian Publish
https://github.com/wchorski/PyWrite-Publisher
Last synced: 2 months ago
JSON representation
alternative to Obsidian Publish
- Host: GitHub
- URL: https://github.com/wchorski/PyWrite-Publisher
- Owner: wchorski
- License: gpl-3.0
- Created: 2022-10-11T19:56:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-05T03:42:16.000Z (10 months ago)
- Last Synced: 2024-08-01T21:43:48.751Z (5 months ago)
- Language: CSS
- Homepage: pywriter-devgarden.vercel.app
- Size: 10.3 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- project-awesome - wchorski/PyWrite-Publisher - alternative to Obsidian Publish (CSS)
- jimsghstars - wchorski/PyWrite-Publisher - alternative to Obsidian Publish (CSS)
README
# nextjs-obsidian-publish
alternative to Obsidian Publish
codename: *Obsidian.md Pyrite Publisher*
## 🎁 Features
0. interactive node graph
0. callout quote blocks
0. markdown links (no support for wiki links)
0. file tree navigation
0. interactive table of contents
0. markdown images (external and internally hosted)
1. fuzzy site search
## 📷 Screenshots
## ⚙ 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/`
```shell
./MarkdownVault/
- index.md
- file1.md
- file2.md
* folderA/
- fileA1.md
- fileA2.md
```
2. include a `./MarkdownVault/index.md` that acts as the glossery of your notes
3. if building with docker
- `docker compose up -d`
4. else
- `npm run init`
- `npm run build`
## 👇 Markdown Tips
```md
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
```md
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
```md
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