Gitliv NPM | npm.io

gitliv-CLI

gitliv is a Node package that allows you to create static applications from markdown files. gitliv ships with a immersive jsx component library that allows you to create beautiful web applications with ease.

gitlivGIf

To get started, install gitliv and create a new project.

npm install
npm run build // Will generate all the required files under the dist folder
npm link // eventually npm -g install gitliv  npm -g install gitliv@1.1.3
npm publish // Will push the latest to the public npm registry. Make sure the version is updated before you do this.
mkdir gitlivFiles && cd gitlivFiles // must be named this
gitliv init // sets up the gitlivFiles directory
gitliv watch // starts a dev server

gitliv was designed to help users create immersive documentation, slides and mdx powered application with ease. It is built to be packaged inbetween existing codebases. The recommended structure:

.
└── current-project/
    ├── gitlivFiles/
    │   ├── pages/
    │   │   ├── my_pages.mdx
    │   │   └── ...
    │   └── public/
    │       ├── my_static.png
    │       └── ...
    └── other_code...

🧞 Commands

All commands are run from the mdknightFiles folder of the project, if one does not exist, create it:

Command	Action
`gitliv init`	Starts an gitliv folder with base template
`gitliv watch`	Starts local dev server at `localhost:3000`
`gitliv build`	Build your production site to `./dist/`
`gitliv serve`	Preview your build locally, before deploying
`gitliv deploy`	Deploys the gitliv build into a deployment channel