Skip to content

SebastianRzk/Looksyk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Looksyk

banner

GithubCI

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

Find the complete documentation at sebastianrzk.github.io/Looksyk

Key Features

  • Local Storage: Your information is always exclusively in Markdown files (currently in testing: sync with a git repository).
  • Fast and Efficient: Scans and indexes large knowledge bases 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: Configure your own design with color variables or custom css, or choose from eight prebuild themes.

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 the build-in git-sync 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 knowledge bases 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.
  • Custom styling of markdown content with html and css and support for custom themes.

Check out screenshots to see how each feature can be used!

Install it and try it out! Installation Guide

Implemented Features

  • Pages
  • Journal (infinite scrolling page, single day page, journal overview page)
  • Todos
  • Content assist
    • Creating links, inserting queries, tags, templates 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
  • Templates
  • Queries (placeholders for dynamic content):
    • Query blocks
    • Query todos / visualize progress of todos
    • Query page hierarchy
    • Query 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.
  • Custom styling of markdown content with html and css
  • Sync your graph with a git repository. Combine this feature with a docker deployment on a server to have a simple web version of your knowledge base.

Are you missing something? Create an issue and/or a pull request!

How can you get the most out of Looksyk with these features? Learn more in the Configuration and Usage page.

Install it and try it out! Installation Guide

Out of scope

  • Non-Markdown content (e.g. flashcards, whiteboards)
  • PDF annotation
  • Dynamic backend plugins
  • Server version / multi user / rcs
  • i18n
  • Sync with sophisticated conflict management. The Git-Sync implementation offers only basic conflict resolution strategies. For more data security and sync options, choose a sync tool of your choice, such as

Development

License

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