Code Monkey home page Code Monkey logo

note-rack's Introduction

Wakatime Note Rack stats

๐ŸŒณ Features

  • Markdown
    • Headings (H1 - H5)
    • Quotes
    • Call Outs
    • Math
  • Inline Blocks
    • Bold
    • Italic
    • Underline
    • Strikethrough
  • Other Features

๐Ÿ“„ Markdown Syntax

  • Headings
    • # - H1
    • ## - H2
    • ### - H3
    • #### - H4
    • ##### - H5
  • Inline Blocks
    • ** Bold
    • * Italic
    • __ Underline
    • -- Strikethrough
  • Other
    • > Quote
    • | Callout
    • $$ Math (KaTeX)
    • [[ Page Name ]] Page ("Page Name" can be any string)

๐ŸŽน Keyboard Shortcuts

  • Ctrl + F or Cmd + F Global Search
  • Ctrl + P or Cmd + P Save Page

๐Ÿ“ฆ Installation

  1. Clone the repo

    git clone https://github.com/Eroxl/Note-Rack.git
  2. Navigate to the repository

    cd ./Note-Rack
  3. Copy the server environment file and fill in the values

    cp ./config/.env.example ./config/.env
  4. Install Docker and Docker Compose

  5. Run the Docker Compose file

    yarn start
  6. Navigate to the web application at http://127.0.0.1:3000

note-rack's People

Contributors

eroxl avatar tobycm avatar xpug avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

note-rack's Issues

Text Block Tests

Description

Add tests for text blocks

Checklist to test for

  • The block can change from plain text to all other text block related styles
  • The block can change back to plain text
  • The block's key binds can be used to change the style of the block

Related Files

https://github.com/Eroxl/Note-Rack/blob/main/web/src/components/blocks/TextBlock.tsx
https://github.com/Eroxl/Note-Rack/blob/main/web/src/constants/BlockTypes.ts
https://github.com/Eroxl/Note-Rack/blob/main/web/src/constants/TextStyles.ts

[Feature] Slash Menu

Implement a slash menu to allow users to insert blocks or change the current block type with ease

[Feature] Websockets Connection

The user is able to successfully connect to the server on a two way web sockets connection and changes are stored in memory and then saved to the database after a period.

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.