Git Product home page Git Product logo

bdvstg.github.io's Introduction

MDBlog - Markdown Blog

a project of "Use GitHub/Markdown as blogging platform"

feature

  • simple and tiny (for programmer)
  • write blog using markdown
  • article stored in github
  • Windows compatible (Git built-in MINGW64)
    • I'm current using win10 git 2.23.0
  • syntax highlighting to markdown's code block
  • history of article (works only github.io)

target

  • article with label
  • split view
  • search (works only github.io)

using

  • javascript
    • vue (UI)
    • axios (fetch)
    • markdown-it (convert markdown to html with syntax highlight callback)
    • highlightjs (syntax highlight)
  • git
  • perl (for create list)
    • JSON::PP (convert to json format, should be built-in in git 2.23.0)
  • python (for test locally)

brief

  • perl script create list (index) of article and label
  • push all to github
  • axios fetch list from github, vue show to list view
  • user click a article in list view
  • fetch markdown file from github
  • convert markdown to html
  • show to specific split view
  • github provide search function and tree snapshot function
  • history of article
    • use git to build list of history (sha hash) of folder
    • switch to specific github/tree

note

  • can not drag index.html to chrome to test, it block by CORS policy
  • for publish to github, only repository named 'username.github.io' works
  • for locally test, just run a http server
    • apache, nginx, ...
    • I'm using python's SimpleHTTPServer, run below in root of project
      • 'python3 -m http.server 8080'
      • or 'python2 -m SimpleHTTPServer 8080'

bdvstg.github.io's People

Contributors

bdvstg avatar

Watchers

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