Giter VIP home page Giter VIP logo

markdown_server_documentation_generator's Introduction

Markdown Generator - Generating Server Documentation

Based on markdown-readme-generator project by Pedro Marinho (GitHub : @pedroermarinho)

Remastered by Florian GIGOT (Github : @florianG37).

Copyright © 2020 Florian GIGOT.

This project is MIT licensed.

Notice utilisateur

Installation

  • Installez python 3
  • Téléchargez generator.zip
  • Lancez setup.bat

Utilisation

  • Lancez generateJSON.bat pour générer le JSON associé au template
  • Remplissez le readme.json
  • Lancez generateMD.bat
  • Le résultat est écrit dans le fichier README.md

Modification du template

  • Model/readme.py : Déclaration des variables
  • templates/default.pmd : Déclaration du template
  • infos.py : modifier le json généré par défaut

markdown_server_documentation_generator's People

Contributors

floriang37 avatar

Watchers

avatar

Forkers

gip-recia baptistecoquet00

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.