Giter Club home page Giter Club logo

iap2020-mkdocs's Introduction

 

IAP-mkdocs-logo

IAP 2020: Introduction to Markdown and MkDocs


code style: prettier

Why? start with why

Markdown is a lightweight markup language that:

  • is very easy to pick up;
  • can be converted into many file formats such as PDF, DOCX, EPUB, HTML, etc. using Pandoc;
  • can generate diagrams such as UML Sequence Diagrams, Flowcharts, Class and State Diagrams;
  • can be used to create a static site, using the static generator MkDocs.

Prerequisites

  • Python 3 with pip installed
  • GitHub account

Workshop materials

Special thanks to...

Another project by...

👤 Wei Min Cher @flamanta

Please ⭐️ this repository if this project helped you!

iap2020-mkdocs's People

Contributors

flamanta avatar imgbotapp avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Forkers

lizcoultersmith

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.