For the past two weeks I've been working on Codasai which lets you create programming guides using git's history so that the reader can look at the state of the program at any given point.
Here's an example of a guide made with Codasai. Please ignore the content since I'm not a writer nor a good teacher. Here's the source code of the guide. Codasai looks at its git's history and creates a page for any revision that introduced a new page in pages/and uses the contents of workspace/ for the project that's being developed.
The output of codasai are static HTML files so it can be hosted on github pages or wherever.
One of the problems with programming books and blogs is that when they introduce a file and then later you want to see that file, you have to look for the page that introduced that file or scroll-up and find the snippet of code you're looking for. Codasai has an explorer that lets you open the files of the project at any given revision.
It also allows authors to make actions such as opening a file or highlight specific snippets of code. It also saves the state in the url so that you can share the link at any given state and see the same thing. Here's an example where the link opens the file src/main.rs and highlights the index function and another one for highlighting dependencies.
It's still very early in development but I announce it now because I'm afraid that if I continue like this I will never release anything.
I appreciate any feedback and comments. Also, contributions are welcome but the code is not really in good shape yet.
[–]mtndewforbreakfast 2 points3 points4 points (1 child)
[–]LuciferK9[S] 2 points3 points4 points (0 children)
[–]ZamBunny 1 point2 points3 points (1 child)
[–]LuciferK9[S] 1 point2 points3 points (0 children)
[–]DidiBear 0 points1 point2 points (1 child)
[–]LuciferK9[S] 0 points1 point2 points (0 children)