/docs/README.md

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

    

  1. # DeckDeckGo - Docs
    2. 

  2. 

  3. This project is the documentation for developer of [DeckDeckGo].
    4. 

  4. 

  5. It is available online at [https://docs.deckdeckgo.com](https://docs.deckdeckgo.com).
    6. 

  6. 

  7. ## Table of contents
    8. 

  8. 

  9. - [Getting Started](#getting-started)
    10. 

  10. - [Markdown](#markdoown)
    11. 

  11. - [License](#license)
    12. 

  12. 

  13. ## Getting Started
    14. 

  14. 

  15. To develop and run this documentation locally, proceed as following:
    16. 

  16. 

  17. ```
    18. 

  18. git clone https://github.com/deckgo/deckdeckgo
    19. 

  19. cd deckdeckgo/docs
    20. 

  20. npm install
    21. 

  21. npm run start
    22. 

  22. ```
    23. 

  23. 

  24. ## Markdown
    25. 

  25. 

  26. The documentation is written in markdown and the app itself is developed with the [Ionic PWA Toolkit](https://ionicframework.com/pwa/toolkit).
    27. 

  27. 

  28. Before building the application, the markdown content is going to be parsed to HTML and injected in its source code (TSX). 
    29. 

  29.  
    30. 

  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.