Giter Club home page Giter Club logo

markade's Introduction


markade

A static site generator using Pug, Markdown and YAML

Installation

  npm install -g markade

Usage

  markade -h
    init [directory]                Initialize a markade directory
    compile [directory]             Compiles a markade directory
    watch [options] [directory]     Watches for changes and sets up a dev server

Init

  1. (Optional) Make a new directory.
  2. To initialize, run markade init <directory>. This will create a markade.json file and copy over the sample templates and data.
  3. You can edit the markade.json file as you wish, such as the paths for outut, template or data.

Compile

  1. (Optional) Move into your directory.
  2. To compile, run markade compile <directory>. This will look for markade.json you created earlier then look for data files in the data directory you specified and compare them against the templates in the following way:
  3. A YAML variable template: file.jade specified.
  4. Templates defined in your markade.json in a templates object. "templates": {"file.jade": "file.md"}
  5. If none found, it defaults to a file with the same name in the template directory.
  6. Then it will write the file in the same relative path as your data file in your output directory in the following way:
  7. A YAML variable output: file.xml specified.
  8. The same name and relative path as your data file: data/about/index.md -> public/about/index.html.

Watch and Server

  1. To watch for changes and run a server, run markade watch <directory>

License

MIT © illyism

markade's People

Contributors

illyism avatar thomastoye avatar

Stargazers

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

Watchers

 avatar  avatar  avatar

Forkers

nedomas gcoda jdkdev

markade's Issues

Live reload does not reflect changes in pug files

When i make changes in css or content, the live reload is working nicely when using the watch.

All changes inside the template pug file is not updated.

When compiling, there is no error and the website is running.

Thanks for that tool!

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.