Skip to content

SebastianRzk/Looksyk

Repository files navigation

Looksyk

logo

GithubCI

A simple personal knowledge platform with a focus on clean markdown files, simple queries and a journal.

Key Features

  • Local Storage: Your information is always exclusively in Markdown files.
  • Fast and Efficient: Scans and indexes large graphs in under a second.
  • Developer-Centric: Insert code blocks with syntax highlighting, save and display existing code files. Save and display backups of websites in your pages.
  • Simple Queries: Use case based query language.
  • Customizable Design: Supports dark mode, light mode, and extra dark mode.

Read more in What are the key selling points compared to other knowledge platforms?

intro animation

Table of Contents

Further Reading

Introduction

I have always been a fan of Logseq, but there were a few things that bothered me, such as the many control characters in the markdown files, the query language that is difficult to learn and limited in its capability, or the general performance. When the database version announced the move away from Markdown as the leading data storage format, I tried to write my own client: Looksyk (name may need to be changed).

What are the key selling points compared to other knowledge platforms?

  • Runs local on your computer.
  • Your information is always exclusively in the Markdown files. No replication in a database or similar. The files can be easily synchronized with other sync tools.
  • Based on blocks, but these can also be larger, contain entire chapters and multiple queries.
  • Simple, use case based query language.
  • Multiple instances of Looksyk with different graphs can be opened in parallel.
  • Developer-centric file support:
    • Insert code blocks with syntax highlighting
    • Save and display existing code files in your pages with syntax highlighting
    • Save and display backups of websites in your pages (with single-file-downloader)
    • Insert videos, audio files, images, text files and PDFs.

Implemented Features

  • Pages
  • Journal (infinite scrolling page, single day page, journal overview page)
  • Todos
  • Content assist
    • Creating links, inserting queries, tags and media
  • View (and link) media
    • Images
    • PDFs
    • HTML Files (e.g. SingleFile saved pages from SingleFile Firefox or SingleFile Chrome)
    • Video (html5 video player)
    • Audio (html5 audio player)
    • Code (with highlighting)
    • Text files
  • Queries (placeholders for dynamic content)
    • Query todos
    • Page hierarchy
    • References
    • Render video, audio, images, text files and code files (with highlighting)
  • Search across all pages and journals
  • Delete and rename pages (and update references across all pages and journals)
  • Favourites
  • History: Show, drop, navigate to previous and next page. Keyboard shortcuts available.

Out of scope

  • Non-Markdown content (e.g. flashcards, whiteboards)
  • PDF annotation
  • Dynamic backend plugins
  • Server version / multi user / rcs
  • i18n
  • Sync with other devices. Please use other tools like Nextcloud, git or OneDrive to sync your graph

License

This project is licensed under the AGPL3 License - see the LICENSE file for details.