Giter Club home page Giter Club logo

quilly's Introduction

Quilly

A simple privacy-first, self-hosted note taking webapp, written in python.

list notes

read note

Why

Quilly is a no-frills, open-source markdown note-taking app. It keeps things simple in a world of feature-packed and bloated alternatives. Its minimal and straightforward and does only one job - helps in taking notes.

Features

  • Markdown based
  • All files saved locally
  • Tag your notes
  • Code highlighting

Installation

Without Docker

  • Clone or download the repository
  • Create and activate virtual environment
  • Install dependencies
pip install -r requirements.txt
  • Run
python3 run.py

With Docker

  • Clone or download the repository
  • Run
docker-compose up -d

Configuration

All notes by default are created in data folder. Also by default all attachments also have to be in data folder. These can be changed by modifiying config.py file.

Syntax

Quilly keeps things simple with the default markdown syntax for text. You can create headings, lists, and emphasize text, just as you would in any markdown editor.

Tagging Your Notes

In Quilly, you have the option to tag your notes. The syntax is straightforward: use

Tags : [tag1 tag2 etc]

within your note to categorize it for easy reference.

Managing Local Attachments

For local attachments, such as images, use below syntax.

!()[attachments/image.png]

This way, you can effortlessly include images in your notes, keeping everything neatly organized.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.