https://github.com/davibe/caccuino

render markdown documents with support for codeblock syntax hilight and mermaidjs diagrams
https://github.com/davibe/caccuino

highlightjs markdown mermaidjs web wiki

Last synced: 17 days ago
JSON representation

render markdown documents with support for codeblock syntax hilight and mermaidjs diagrams

• Host: GitHub
• URL: https://github.com/davibe/caccuino
• Owner: davibe
• Created: 2019-06-14T20:18:43.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T02:42:21.000Z (almost 2 years ago)
• Last Synced: 2024-10-14T17:55:58.343Z (about 1 month ago)
• Topics: highlightjs, markdown, mermaidjs, web, wiki
• Language: CSS
• Homepage:
• Size: 1.01 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# caccuino

I use this to serve simple technical wikis that are purely based on markdown, the good old filesystem and no configuration

    sudo npm install -g caccuino --unsafe-perm=true # or `npm link .` from this repo

    cd /folder/with/markdown/files # for example `example` dir in this repo

    caccuino

![screenshot](screenshot.png)

The spawned server will serve 

- searchable file listing for directories

- a rendered version of the markdown files

  - using `style.css` from the root directory

  - with codeblock syntax hilight

  - with rendering of mermaidjs diagrams

  - including a responsive sidebar with

    - an outline of the current document

    - a pdf download link

    - a list of adjacent files

- a PDF rendered version of the markdown files

  - using puppeteer serverside for consistent results

  - automatically hiding sidebar and other styles that are not printable

  - still using `style.css` from the root directory (printable media)

- serve any other static file as is (images, artifacts..)

#### Under development

- [x] render an outline of the current document

- [x] render a filetree of adiacent documents

- [x] better printable css media

- [x] Pdf rendering

- [ ] hotreload changes (?)