Git Product home page Git Product logo

mdtowiki's Introduction

Markdown to Wiki

Grabs markdown files from source code and generate structured Wiki wth it.

Goals

The intention is to include a task in the build step that will collect all documentation in the format of markdown files that are spread in code base and make a copy of them, for versioning reasons since GitHub Wiki are in another git address. This script requires 1 input information that is how the Table of Contents should be organized. This is semanticaly individual for each kind of project, the default behavior is reflect documentation in the file system tree shape, whenever found a README.md in any folder that point will represent a subsection of outlined content.

UNDER DEVELOPMENT

  • Basic source code structure
  • Define configuration
  • Define tests
  • Write script
  • Write docs
  • Provide example

mdtowiki's People

Watchers

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