Giter VIP home page Giter VIP logo

flatgit's Introduction

flatgit

A git-based, flat-file CMS with a WYSIWYG editor that pulls documentation content from any repos you specify

Installation

Soon, this will be available as an npm package and a Docker image but, for right now, this is the way.

Git

$ git clone https://github.com/flatgit/flatgit && cd flatgit
$ npm i
$ npm run serve

Docker

docker build -t <TAG> .
docker run -p <LOCAL>:8000 <TAG>

ROADMAP

  • Creation of config file for git repos and tokens
  • Specifying repositories to pull from (supporting open source projects first and foremost)
    • All files should be in md or txt and inside the docs folder
    • Consider supporting the docs branch that Github uses also
  • Webhook implementation to pull from repos when a change has been made
  • Theming options for rendering content
  • URL mapping from flatgit to documentation path
    • Paths to files outside of the docs/ folder should redirect to the source repo
  • Authentication (potentially through Oauth or tokens) to edit pages in browser
  • Package and publish to npm

flatgit's People

Contributors

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