Giter Site home page Giter Site logo

yarc's Introduction

yarc

yarc

General Info

yarc gives you a "box" of notes. It is a minimal micro-homage to the bi-directional linking in tools like Roam Research.

Notes

Every note has a url at: :base_url/notes/:note_name

The notes are also accessible via API:

GET :base_url/notes/:note_name?json=true

You can edit notes using the edit button, writing regular markdown. save will save your changes and switch to a notes view.

You can link to any note in your box using the convention [[note_name]].

  • This creates bi-directional links.

A list of all notes that link to the present note are under a header Backlinks.

Home

The home page lets one search for or go directly to notes.

  • search: brings up all notes that contain a given query.
  • go: brings you directly to a (potentially new) note.

Deploying

My instance of yarc is running on Deta.

It could, with little modification, be configured to run elsewhere (it's a FastAPI app), but a database is needed.

On Deta

  1. Clone the GitHub repo.

  2. Login to the Deta web app, and a 'default project' will be created (if you have a project, you can skip this step).

  3. Install the Deta CLI and use 2 commands from within the yarc directory:

deta login
deta new

Your copy of yarc should be live for personal use (you can get the url from a deta details cli command or from the Micros dashboard within Deta).

The endpoint and "box" are protected by default, but is accessible if one is logged in to Deta, with api keys, or by making it public.

Libraries Used

yarc's People

Contributors

xeust avatar dependabot[bot] avatar rud avatar

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.