Code Monkey home page Code Monkey logo

weinote's Introduction

Weinote

WeiNote

Keep a note just like post a weibo!

docker

View Demo
English · 简体中文

1. Features

Main

  • Multi tags
  • Markdown
  • Latex
  • Support fully private mode
  • Shortcuts

Editor

  • Codemirror Markdown Editor
  • Continued List
  • Auto Indent List (Tab and Shift + Tab)

Functions

  • Markdown Preview (like github preview or Ctrl + Space)
  • Raw content (like github)
  • Hide a note
  • Top a note
  • Archive a note

2. Demo

https://demo.wnote.cc
demo user: weinote
demo pw: 9vzVABUa30LSldiVVJt5

3. Install with Docker

Install

cd directory/you/want/to/run
mkdir weinote && cd weinote
wget https://raw.githubusercontent.com/yueyericardo/WeiNote/master/docker-compose.yml && wget https://raw.githubusercontent.com/yueyericardo/WeiNote/master/init-mongo.sh && chmod +x init-mongo.sh
docker-compose up -d

Signup, the default port is 3081, e.g.: http://example.com:3081

Disable signup

After you signup,in file docker-compose.yml, change allow_signup: "true" to allow_signup: "false",So others cannot sign up. After update, you can reload weinote with the following

docker-compose up -d

Proxy

Use Nginx for your domain,and Certbot for https

Update from the latest image

docker-compose down && docker-compose pull && docker-compose up -d

Multiple instances

You can find how to create multiple instances at the following example (with notes): https://github.com/yueyericardo/WeiNote/blob/master/docker-compose.multi.yml

4. Shortcuts

  • Mac OS:

    • Ctrl + N : Go to Create page

    • Alt + N : Open Create page at a new page

    • Ctrl + H : Go to Home page /notes

    • Ctrl + A : Go to All notes page /notes/all

    • Ctrl + C : Redirect to Archive notes page /notes/archive

  • Other System:

    • Alt + N : Go to Create page

    • Alt + H : Go to Home page /notes

    • Alt + A : Go to All notes page /notes/all

    • Alt + C : Redirect to Archive notes page /notes/archive

  • Common

    • E : Edit selected note
    • D : Delete selected note

5. Contribute

Welcome PR! Especially for security problems.

6. Acknowledge

Based on N-blog
License GPL

weinote's People

Contributors

yueyericardo avatar

Stargazers

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

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

weinote's Issues

Preview

preview the markdown just like github
After preview, manually click a save button to save when you are editing big note?

Paging support

If there are too many posts , with paging support, I think the performance will be better.
Thanks.

Docker

Create a docker for quick deployment.

[Feature proposal] Sidebar

Pin some frequently needed notes on the sidebar with title only, instead of cmd+F to search every time.

  • Sidebar will only shown when screen is large enough
  • Only shown after login
  • A note could be dragged into the sidebar, and could be drag to reorder the list.

Content:

  • Title with link to the note's anchor point.
  • Sort by date
  • Sort by tag

Muti User

Support Multi Users.
This should be done in a seperate repo.

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.