Code Monkey home page Code Monkey logo

easymanual's Introduction

What is Easy Manual?

An easy way to generate documentation for a project. It parses the contents of the specified input folder, looks for files ending in '.em.md' and converts the markdown to templated html. Markdown is a very common, very simple markup language Markup Documentation

How it works:

Styling and formatting is limited to the Nunjucks template being used. Menu nav items are created by taking the filename of the .em.md file.

Easy manual expands on markdown slightly by adding Tags.
Supported Tags include:

  • Page
  • Image
  • Group

Page Tag

Allows you to easily reference another page from with the markdown by writing @Page[MyPage].

Image Tag

Same as Page but for images and the file extension must be used: @Image[MyImage.jpg]. Only use the file name, do not reference the full path.

Group Tag

Places nav links into an accordion style nav element by group

easymanual's People

Contributors

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