gmlwo530 / code-process-generator

Generate a markdown of the process of the code.

Code Process Generator

Code Process Generator is generator that generates a markdown of the process of the code. (This project is under development. If you find a bug, please report it to the issue.)

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Usage
3. Roadmap
   • Doing
   • TODO
4. Contributing
5. License
6. Contact
7. Acknowledgements

About The Project

This project make process of your code to markdown file. Whenever I took a programming class, I faced a common problem. At the end of the lecture, only one code containing the subject of the lecture remains, and there are no steps left to create this result.

So, I make this project to remain steps of result.

Now, CPG(code process generator) support only javascript. I plan to support other languages ​​as soon as possible.

I hope this project will help you in your development process.

Built With

• React

Usage

1. Write code.
2. Save code to frame.
3. Download frames to markdown!

Roadmap

Doing

• Save code
• Edit code
• Save frame
• Edit frame
• Delete frame
• Generate markdown
• Header & Footer
• Support other programming languages
• Refactoring UI

TODO

• Description editor for code
• Themes
• Next.js

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/YourFeature)
3. Commit your Changes (git commit -m 'Add some YourFeature')
4. Push to the Branch (git push origin feature/YourFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

CHOI HEE JAE - @gmlwo530 - [e-mail]

Acknowledgements

• React
• Type script
• GitHub Pages