I am too impatient to wait for Copilot for Docs and, from what I have seen so far, it is not going to be exactly the tool I want. So time to create our own!
Code-umentary is a web-based editor for creating code documentation, or actually anything else where you want some AI assistance to learn new skills. It allows users to create a document with code snippets, explanations, and formatting options, all in one place. That sounds perfectly boring, but the main feature is that integration with the GPTs to both help you write code and create learning notes for yourself and others.
Code-umentary is a web-based application that can be run on any modern web browser. Simply navigate to the demo page to start using it.
If you want to install it locally, you can clone the repository and run the application using a local web server:
git clone https://github.com/JohnnyFoulds/code-umentary/code-umentary.git
cd code-umentary
python -m http.server -d srcThen, navigate to http://localhost:8000 in your web browser.
To get started with Code-umentary, simply open the application and start creating your document. You can add code snippets, format text, and add explanations as needed. Once you're finished, you can export your document as a MARKDOWN file for easy sharing and collaboration.
If you'd like to contribute to Code-umentary, please follow these steps:
- Fork this repository
- Create a new branch (
git checkout -b feature/new-feature) - Make your changes and commit them (
git commit -am 'Add new feature') - Push to the branch (
git push origin feature/new-feature) - Create a new pull request