Git Product home page Git Product logo

archivy's Introduction

logo

Logo design by Roy Quilor is licensed under CC BY-NC 4.0

Archivy

Archivy is a self-hosted knowledge repository that allows you to safely preserve useful content that contributes to your own personal, searchable and extensible wiki.

Features:

  • If you add bookmarks, their web-pages contents' will be saved to ensure that you will always have access to it, following the idea of digital preservation.
  • Login module that allows you to host the service on a server
  • Plugin system to allow people to publish and write extensions to archivy
  • Notes are stored in an extended markdown format with footnotes, LaTeX math rendering, syntax highlighting and more.
  • CLI that provides a nice backend interface to the app
  • Git integration
  • Backend API for flexibility and user enhancements
  • Everything is a file! For ease of access and editing, all the content is stored in markdown files with yaml front matter.
  • Extensible search with Elasticsearch and its Query DSL
  • Dark Theme

demo (low res)

Upcoming:

  • Links between different knowledge base items
  • Multi User System with permission setup.
  • Major improvements in UI
  • Option to compile data to a static site.

Quickstart

Install archivy with pip install archivy. Other installations methods are listed here

Then run this and enter a password to create a new user:

$ archivy create-admin <username>

Finally, execute archivy run to serve the app. You can open it at https://localhost:5000 and login with the credentials you entered before.

You can then use archivy to create notes, bookmarks and then organize and store information.

See the official docs for information on other installation methods.

archivy's People

Contributors

bislara avatar cktang88 avatar clemux avatar dependabot[bot] avatar harshavardhanj avatar imgbotapp avatar lhl avatar siraben avatar srevinsaju avatar thethales avatar tynen avatar uzay-g avatar

Watchers

 avatar  avatar

Forkers

keyurparikh

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.