/webcomponents/highlight-code/README.md

https://github.com/deckgo/deckdeckgo · Markdown · 34 lines · 21 code · 13 blank · 0 comment · 0 complexity · 225e6cdb581506aae993e6d2cfff7473 MD5 · raw file 

    

  1. # DeckDeckGo - Highlight Code
    2. 

  2. 

  3. This component is the code highlighter of [DeckDeckGo].
    4. 

  4. 

  5. It is developed with [Stencil](https://stenciljs.com) and use [Prism.js](https://prismjs.com) from [Lea Verou](http://lea.verou.me) and [James DiGioia](https://twitter.com/jamesdigioia) for the highlighting itself.
    6. 

  6. 

  7. Furthermore, the inspiration for the design of the cards comes from the amazing [carbon](https://carbon.now.sh), a tool to create and share beautiful images of your source code.
    8. 

  8. 

  9. ## Table of contents
    10. 

  10. 

  11. - [Getting Started](#getting-started)
    12. 

  12. - [Develop](#develop)
    13. 

  13. - [License](#license)
    14. 

  14. 

  15. ## Getting Started
    16. 

  16. 

  17. To get started with this Web Component, have a look to its [documentation](https://docs.deckdeckgo.com/components/code).
    18. 

  18. 

  19. ## Develop
    20. 

  20. 

  21. To develop and run this Web Component locally, proceed as following:
    22. 

  22. 

  23. ```
    24. 

  24. git clone https://github.com/deckgo/deckdeckgo
    25. 

  25. cd deckdeckgo/webcomponents/highlight-code
    26. 

  26. npm install
    27. 

  27. npm run start
    28. 

  28. ```
    29. 

  29. 

  30. ## License
    31. 

  31. 

  32. MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com)
    33. 

  33. 

  34. [DeckDeckGo]: https://deckdeckgo.com
    35.