Giter Site home page Giter Site logo

converter-md2html's Introduction

converter-md2html

Tool to convert markdown (.md) files to html using showdown, formatted using github-markdown-css & highlight.js For further information on showdown see: http://www.showdownjs.com/ or https://github.com/showdownjs/showdown/wiki For further information on github-markdown-css see: https://github.com/sindresorhus/github-markdown-css For further information on hightlight.js see: https://highlightjs.org/ or https://github.com/highlightjs/highlight.js

Browser-based conversion is available under browser/mdConv.html

  • Paste the .md file contents into the top window and click convert to get the html formatted code & an html view of the code

INITIAL SETUP OF DIRECTORIES AND RUNNING NODE

CONBINE NEXT 2 ACTIVITIES INTO ONE

MOVE REPO SPECIFIC DETAILS

Activities to convert into HTML first time:

  • Using GitBash, clone repository from GitHub: git clone {repository}
  • List all markdown files in main directory & sub-directories: ls -1d *.md /.md
  • Create batchFile to convert all markdown files to html format
  • Remove any existing files from ./output-html & create any required sub-directories
  • Using Node.js Terminal, convert docs to html format: {batchFile}
  • Copy any {additionalFiles} from repository into ./output-html
  • Update each html using _template.html as the template, plus any additional {updates), and check all looks OK
  • Move contents of ./output-html directory and sub-directories to final destination

Activities to update HTML subsequent times:

  • Using GitBash, update files from GitHub: git pull {repository}
  • (Using Node.js Terminal, ensure showdown is up-to-date: npm update) ************************* AND COPY CSS & JS FILES TO SUBDIRS
  • List all markdown files in main directory & sub-directories: ls -1d *.md /.md
  • Update relevant batchFile with any changes
  • Remove any existing files from ./output-html & create any required sub-directories
  • Using Node.js Terminal, convert docs to html format: {batchFile}
  • Copy any {additionalFiles} from repository into ./output-html
  • Update each html using _template.html as the template, plus any additional {updates), and check all looks OK
  • Move contents of ./output-html directory and sub-directories to final destination

Repository-specific information.

ethereumbook:

  • Repository: [email protected]:ethereumbook/ethereumbook.git
  • Directory: C:/Users/Mark/Documents/GitHubRepositories/ethereumbook/
  • batchFile: mdConv-ethbook.bat
  • AdditionalFiles:
  • Updates: readme.html: update book.asciidoc link to html
  • Final Destination: \Malarena SA\Blockchain\Ethereum\ethereumbook

styleGuide-javascript:

  • Repository: [email protected]:MarkKensington/styleGuide-javascript.git
  • Directory: C:/Users/Mark/Documents/GitHubRepositories/styleGuide-javascript
  • batchFile: mdConv-sgjavascript.bat
  • AdditionalFiles:
  • Updates: readme.html: fix h2 id's with missing dashes & links to other .md files
  • Final Destination: \Malarena SA\Development\StyleGuides\JavaScript

TO DO:

  • Update this README.md file with proper markdown comments
  • Remove all the hardcoding
  • Improve the code so that it reads the files from a database or ini file

TRY TO GET convert button to make it re-highlight without need to press reset

converter-md2html's People

Contributors

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