Giter Club home page Giter Club logo

mdlight's Introduction

Read me please

Description

Web viewer for the bunch Markdown documents in directories.

I make almost all my notes in .md format and store it in git repo.

There are a lot of advantages, such as:

  • I can write it in vim
  • I can store it in git
  • I can distribute it on all my computers (including my phone)
  • I can replicate it, just because it is git
  • I can insert pictures or something else in my notes

Arguing dialectically I should mention some disadvantages:

  • I am not able to show it to "normal" guys easily
  • I am not able to share it to other people by link
  • I am not able to see pictures in my notes, only links on it
  • I am not able to read it on my phone

Some of this problems I am tried to solve by mdlight.

Requirements

To run:

To test:

  • python3-pytest

How to run

Run ./mdlight/server.py --help and let see what happen. This is a entry point.

How to test

Run python3 -m pytest cmd to execute all tests.

To do

Some features I would like to make in future:

  • Support HTML pattern page and CSS style
  • I case of perfomance problems it would be helpful to use another web server (e.g. werkzeug) and cache.

mdlight's People

Contributors

akindyakov 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.