Code Monkey home page Code Monkey logo

neobook's Introduction

Neobook

Description

Neobook is a web application that allows users to take notes using the power of markdown and render them in real time. Neobook also allows users to create and manage their own books and notes.

Features

  • Create and manage notes.
  • Real time markdown rendering.
  • Support mermaid, Katex, Pretty Code, and more.

Coming Soon Features

  • Create and manage books and notes.
  • Export notes to PDF and HTML.
  • Share notes with other users.
  • Search for notes and books.
  • Create and manage tags.
  • Create and manage categories.

Requirements

  • Node.js or Bun

Installation

Neobook is currently in development and is not ready for production. However, if you would like to test it out, you can clone the repository and run the following commands:

# clone the repository
git clone https://github.com/CMOISDEAD/neobook.git

# frontend steps
cd frontend
npm install

# backend steps
cd backend
npm install

Usage

Currently is a work in progress, so you can only use the development version, follow the next instructions.

chmod +x ./script
./script

All the supported markdown syntax can be found test.md.

Configuration

Currently you can configure your options in backend/src/config.ts, in a future release you will be able to configure your options in a personal and more comfy file.

Options

  • notesDir: The directory where the notes will be stored.
  • imagesDir: The directory where the images will be stored, this images gonna be served by the backend thats the importances of this path.

Image Gallery

1695532247 1695532277 1695532350

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Neobook is a open source project, so feel free to fork the repository and make your own changes, i will be happy to see them.

License

NeoBook is licensed under the MIT license.

neobook's People

Contributors

cmoisdead avatar

Stargazers

 avatar

Watchers

 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.